diff --git a/config/precache.go b/config/apis.json similarity index 79% rename from config/precache.go rename to config/apis.json index 6a7af6b..9a90450 100644 --- a/config/precache.go +++ b/config/apis.json @@ -1,96 +1,72 @@ -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -package config - -var preCache = `{ +{ "api": [ { - "description": "Lists the resource icon for the specified resource(s)", - "isasync": false, - "name": "listResourceIcon", + "description": "Creates VPC offering", + "isasync": true, + "name": "createVPCOffering", "params": [ { - "description": "type of the resource", + "description": "true if network offering is meant to be used for NSX, false otherwise.", "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" + "name": "fornsx", + "required": false, + "since": "4.20.0", + "type": "boolean" }, { - "description": "list of resources to upload the icon/image for", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "resourceids", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, "type": "list" - } - ], - "related": "", - "response": [ - { - "description": "base64 representation of resource icon", - "name": "base64image", - "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "resourceobjecttype" + "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": "id of the resource", - "name": "resourceid", + "description": "the name of the vpc offering", + "length": 255, + "name": "name", + "required": true, "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if network offering for NSX VPC offering supports Load balancer service.", + "length": 255, + "name": "nsxsupportlb", + "required": false, + "since": "4.20.0", + "type": "boolean" }, { - "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": "set to true if the offering is to be enabled during creation. Default is false", + "length": 255, + "name": "enable", + "required": false, + "since": "4.16", + "type": "boolean" + }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "desired service capabilities as part of vpc offering", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "servicecapabilitylist", "required": false, - "since": "4.13", - "type": "list" + "since": "4.4", + "type": "map" }, { - "description": "services supported by the vpc offering", + "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", "length": 255, - "name": "supportedservices", - "required": true, - "type": "list" + "name": "networkmode", + "required": false, + "since": "4.20.0", + "type": "string" }, { "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", @@ -100,42 +76,44 @@ var preCache = `{ "type": "map" }, { - "description": "desired service capabilities as part of vpc offering", + "description": "Name of the provider providing the service", "length": 255, - "name": "servicecapabilitylist", + "name": "provider", "required": false, - "since": "4.4", - "type": "map" + "since": "4.21.0", + "type": "string" }, { - "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6", + "description": "services supported by the vpc offering", "length": 255, - "name": "internetprotocol", + "name": "supportedservices", "required": false, - "since": "4.17.0", - "type": "string" + "type": "list" }, { - "description": "the name of the vpc offering", + "description": "the routing mode for the VPC offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "name", - "required": true, + "name": "routingmode", + "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "set to true if the offering is to be enabled during creation. Default is false", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "enable", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.16", - "type": "boolean" + "since": "4.13", + "type": "list" }, { - "description": "the display text of the vpc offering, defaults to the 'name'", + "description": "true if the VPC offering supports choosing AS number", "length": 255, - "name": "displaytext", + "name": "specifyasnumber", "required": false, - "type": "string" + "since": "4.20.0", + "type": "boolean" }, { "description": "the ID of the service offering for the VPC router appliance", @@ -146,54 +124,130 @@ var preCache = `{ "type": "uuid" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "the display text of the vpc offering, defaults to the 'name'", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "displaytext", "required": false, - "type": "list" + "type": "string" } ], "related": "updateVPCOffering,listVPCOfferings", "response": [ + { + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" + }, + {}, + {}, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "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 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 zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if vpc offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "the name of the vpc offering", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the provider name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", @@ -203,11 +257,6 @@ var preCache = `{ "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" @@ -233,325 +282,44 @@ var preCache = `{ } ], "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", + "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", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "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": "the date this vpc offering was created", + "name": "created", + "type": "date" } ] }, { - "description": "Creates a new Pod.", + "description": "Creates an account from an LDAP user", "isasync": false, - "name": "createPod", + "name": "ldapCreateAccount", "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", + "description": "details for account used to store specific parameters", "length": 255, - "name": "gateway", + "name": "accountdetails", "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" + "type": "map" }, - { - "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, @@ -568,40 +336,27 @@ var preCache = `{ "type": "integer" }, { - "description": "Network domain for the account's networks", + "description": "Creates the user under the specified domain.", "length": 255, - "name": "networkdomain", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Account UUID, required for adding account from external provisioning system", + "description": "Unique username.", "length": 255, - "name": "accountid", - "required": false, + "name": "username", + "required": true, "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", + "description": "Network domain for the account's networks", "length": 255, - "name": "userid", + "name": "networkdomain", "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, @@ -617,94 +372,45 @@ var preCache = `{ "type": "string" }, { - "description": "Creates the user under the specified domain.", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "userid", "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", + "description": "Account UUID, required for adding account from external provisioning system", + "length": 255, + "name": "accountid", + "required": false, "type": "string" - }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, + } + ], + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "response": [ { "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "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", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { @@ -713,68 +419,63 @@ var preCache = `{ "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of gpus owned by account", + "name": "gputotal", "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "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", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { @@ -783,179 +484,148 @@ var preCache = `{ "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, - {}, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the state of the account", + "name": "state", "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", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, - {}, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "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 tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, + {}, { "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", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "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", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "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": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { @@ -964,23 +634,23 @@ var preCache = `{ "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the user email address", - "name": "email", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -989,24 +659,14 @@ var preCache = `{ "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the api key of the user", - "name": "apikey", + "description": "the user name", + "name": "username", "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": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { "description": "true if user has two factor authentication is mandated", @@ -1014,208 +674,371 @@ var preCache = `{ "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" } ], "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 total number of backups which can be stored by this account", + "name": "backuplimit", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the account", + "name": "id", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, - {}, - {} - ], - "since": "4.6.0" - }, - { - "description": "Copies an iso from one zone to another.", - "isasync": true, - "name": "copyIso", - "params": [ { - "description": "ID of the zone the template is being copied to.", - "length": 255, - "name": "destzoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", - "length": 255, - "name": "destzoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "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": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, + {}, { - "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the size of the template", - "name": "size", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the template name", - "name": "name", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", + "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the template ID", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of backups available to this account", + "name": "backupavailable", + "type": "string" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of gpus the account can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + } + ], + "since": "4.2.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 name of userdata linked to this template", + "name": "userdataname", "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", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { @@ -1224,43 +1047,125 @@ var preCache = `{ "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, { "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", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + {}, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "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 template name", + "name": "name", + "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, + {}, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, { "description": "the date this template was removed", "name": "removed", "type": "date" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { @@ -1268,23 +1173,23 @@ var preCache = `{ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -1298,13 +1203,18 @@ var preCache = `{ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -1313,52 +1223,37 @@ var preCache = `{ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "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", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "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": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { "description": "true if the template is extractable, false otherwise", @@ -1366,56 +1261,29 @@ var preCache = `{ "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", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "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 size of the template", + "name": "size", + "type": "long" }, - {}, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "the status of the template", - "name": "status", + "description": "checksum of the template", + "name": "checksum", "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": "the format of the template.", + "name": "format", + "type": "imageformat" }, { "description": "additional key/value details tied with template", @@ -1423,44 +1291,19 @@ var preCache = `{ "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", + "description": "The ID of extension linked to this template", + "name": "extensionid", "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", + "description": "the template ID", + "name": "id", "type": "string" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" } ] }, @@ -1479,12 +1322,6 @@ var preCache = `{ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -1492,446 +1329,426 @@ var preCache = `{ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "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": "Issues and propagates client certificate on a connected host/agent using configured CA plugin", - "isasync": true, - "name": "provisionCertificate", + "description": "List storage pools compatible with a vSphere storage policy", + "isasync": false, + "name": "listVsphereStoragePolicyCompatiblePools", "params": [ { - "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", + "description": "", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used", + "description": "ID of the storage policy", "length": 255, - "name": "reconnect", + "name": "policyid", + "related": "importVsphereStoragePolicies,listVsphereStoragePolicies", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "description": "List by keyword", "length": 255, - "name": "provider", + "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" } ], + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the storage pool", + "name": "zonename", "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": "the storage access groups for the storage pool", + "name": "storageaccessgroups", + "type": "string" }, { - "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": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "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", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "list by the service offering", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": false, - "since": "4.4", - "type": "uuid" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "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 total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, + {}, { - "description": "the security group ID", - "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", - "required": false, - "since": "4.15", - "type": "uuid" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "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": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "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": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "flag to display the resource icon for VMs", - "length": 255, - "name": "showicon", - "required": false, - "since": "4.16.0.0", + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" + }, + { + "description": "the storage pool type", + "name": "type", + "type": "string" + }, + { + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "whether this pool is managed or not", + "name": "managed", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the pod ID", - "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { - "description": "the host ID", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", - "required": false, - "type": "uuid" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "the target hypervisor for the template", - "length": 255, + "description": "the hypervisor type of the storage pool", "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": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "list vms by iso", - "length": 255, - "name": "isoid", - "required": false, - "type": "uuid" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "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,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "list vms by affinity group", - "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", - "required": false, - "type": "uuid" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "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": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "list by the backup offering", + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + } + ] + }, + { + "description": "Reboots a system VM.", + "isasync": true, + "name": "rebootSystemVm", + "params": [ + { + "description": "Force reboot the system VM (System VM is Stopped and then Started)", "length": 255, - "name": "backupofferingid", + "name": "forced", "required": false, - "since": "4.17", - "type": "uuid" + "since": "4.16.0", + "type": "boolean" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "The ID of the system virtual machine", "length": 255, - "name": "storageid", - "related": "listVsphereStoragePolicyCompatiblePools,cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": false, + "name": "id", + "related": "destroySystemVm,listSystemVms,migrateSystemVm,rebootSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "required": true, "type": "uuid" + } + ], + "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "response": [ + { + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "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": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "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, + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "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, + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "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 link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" }, { - "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,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "since": "4.4", - "type": "list" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, + {}, { - "description": "list vms by ssh keypair name", - "length": 255, - "name": "keypair", - "required": false, + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the group ID", - "length": 255, - "name": "groupid", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", - "required": false, - "type": "uuid" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "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, + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "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 state of the system VM", + "name": "state", + "type": "string" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", - "required": false, - "type": "uuid" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "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": "the agent state of the system VM", + "name": "agentstate", + "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" + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "type": "string" }, { - "description": "list vms by vpc", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - } - ], - "related": "listVirtualMachinesMetrics", - "response": [ + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, { "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", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "network read in MiB", - "name": "networkread", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { @@ -1940,1170 +1757,559 @@ var preCache = `{ "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", + "description": "the ID of the system VM", "name": "id", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "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", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the network domain for the system VM", + "name": "networkdomain", "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": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, { - "description": "disk write in MiB", - "name": "diskwrite", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" - }, + } + ] + }, + { + "description": "List dedicated zones.", + "isasync": false, + "name": "listDedicatedZones", + "params": [ { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "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 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": "the ID of the Zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the domain associated with the zone", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "list dedicated zones by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", + "required": false, + "type": "uuid" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, + } + ], + "related": "dedicateZone", + "response": [ { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", + "type": "string" }, + {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" }, + {}, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the Name of the Zone", + "name": "zonename", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "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 ID of the storage pool", + "name": "id", "type": "string" }, + {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, + {}, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the state of the storage pool", + "name": "state", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "available iops of the pool", + "name": "maxiops", "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "default gateway of the pool", + "name": "gateway", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "controller of the pool", + "name": "controllerid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the current available space of the pool", + "name": "size", + "type": "long" + } + ] + }, + { + "description": "Change the BGP peers for a network.", + "isasync": true, + "name": "changeBgpPeersForNetwork", + "params": [ + { + "description": "UUID of the network which the Bgp Peers are associated to.", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "network write in MiB", - "name": "networkwrite", + "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", + "length": 255, + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForNetwork,changeBgpPeersForVpc", + "required": false, + "type": "list" + } + ], + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", + "response": [ + { + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, + {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "id of the bgp peer", + "name": "id", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, + {}, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "AS number of bgp peer", + "name": "asnumber", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the project id of the vm", - "name": "projectid", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "the project name of the vm", + "description": "the project name of the bgp peer", "name": "project", "type": "string" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "list Tungsten-Fabric LB health monitor", + "isasync": false, + "name": "listTungstenFabricLBHealthMonitor", + "params": [ { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the ID of lb rule", + "length": 255, + "name": "lbruleid", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", + "required": true, + "type": "uuid" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "updateTungstenFabricLBHealthMonitor", + "response": [ { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the health monitor http method", + "name": "httpmethod", "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total disk iops", - "name": "diskiopstotal", + "description": "the health monitor ID", + "name": "id", "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": "the health monitor timeout", + "name": "timeout", + "type": "int" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the health monitor interval", + "name": "interval", + "type": "int" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the health monitor url path", + "name": "urlpath", "type": "string" }, + {}, { - "description": "disk read in MiB", - "name": "diskread", - "type": "string" + "description": "the health monitor retry", + "name": "retry", + "type": "int" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the health monitor UUID", + "name": "uuid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the health monitor type", + "name": "type", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the health monitor expected code", + "name": "expectedcode", "type": "string" - }, + } + ] + }, + { + "description": "Removes external nodes from a CKS cluster. ", + "isasync": true, + "name": "removeNodesFromKubernetesCluster", + "params": [ { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster,removeNodesFromKubernetesCluster", + "required": true, + "type": "uuid" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotal", - "type": "string" - }, + "description": "comma separated list of node (physical or virtual machines) IDs that need to beremoved from the Kubernetes cluster (CKS)", + "length": 255, + "name": "nodeids", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "list" + } + ], + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster", + "response": [ { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "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 ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", + "type": "string" }, - {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", "type": "long" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", "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, + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "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, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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, + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "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,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "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": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "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", + "description": "Maximum size of the cluster", + "name": "maxsize", "type": "long" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the state of the Kubernetes cluster", + "name": "state", "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": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -3111,374 +2317,171 @@ var preCache = `{ "type": "integer" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "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": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "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", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "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": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "events available for the host", - "name": "events", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "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", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "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", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "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", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", "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 type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "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", + "description": "the id of the Kubernetes cluster", + "name": "id", "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", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the Zone name of the host", + "description": "the name of the zone of the Kubernetes cluster", "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": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "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", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "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", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" } - ] + ], + "since": "4.21.0" }, { - "description": "Deletes a storage pool.", - "isasync": false, - "name": "deleteStoragePool", + "description": "Deletes account from the project", + "isasync": true, + "name": "deleteAccountFromProject", "params": [ { - "description": "Storage pool id", + "description": "name of the account to be removed from the project", "length": 255, - "name": "id", - "related": "listVsphereStoragePolicyCompatiblePools,cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "account", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal)", + "description": "ID of the project to remove the account from", "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" } ], "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", @@ -3486,193 +2489,239 @@ var preCache = `{ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "3.0.0" }, { - "description": "List storage pools compatible with a vSphere storage policy", - "isasync": false, - "name": "listVsphereStoragePolicyCompatiblePools", + "description": "Updates the information about Guest OS", + "isasync": true, + "name": "updateGuestOs", "params": [ { - "description": "", + "description": "Unique display name for Guest OS", "length": 255, - "name": "pagesize", + "name": "osdisplayname", "required": false, - "type": "integer" + "type": "string" }, { - "description": "ID of the storage policy", + "description": "UUID of the Guest OS", "length": 255, - "name": "policyid", - "related": "importVsphereStoragePolicies,listVsphereStoragePolicies", - "required": false, + "name": "id", + "related": "listOsTypes,addGuestOs,updateGuestOs", + "required": true, "type": "uuid" }, { - "description": "List by keyword", + "description": "whether this guest OS is available for end users", "length": 255, - "name": "keyword", + "name": "forDisplay", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "ID of the zone", + "description": "the ID of the OS category", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "oscategoryid", + "related": "listOsCategories,addOsCategory,updateOsCategory", "required": false, + "since": "4.21.0", "type": "uuid" }, { - "description": "", + "description": "Map of (key/value pairs)", "length": 255, - "name": "page", + "name": "details", "required": false, - "type": "integer" + "type": "map" } ], - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "related": "listOsTypes,addGuestOs", "response": [ { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the name/description of the OS type", + "name": "description", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the ID of the OS category", + "name": "oscategoryid", + "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "is the guest OS visible for the users", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the storage pool path", - "name": "path", + "description": "the name of the OS category", + "name": "oscategoryname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the OS type", + "name": "name", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the ID of the OS type", + "name": "id", + "type": "string" }, + {}, + {}, { - "description": "the name of the storage pool", - "name": "name", + "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", + "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": "limits search results to allocated guest vlan. false by default.", + "length": 255, + "name": "allocatedonly", + "required": false, "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "list guest vlan by id", + "length": 255, + "name": "id", + "required": false, "type": "long" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "list guest vlan by physical network", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the Zone ID of the storage pool", + "description": "list guest vlan by zone", + "length": 255, "name": "zoneid", - "type": "string" + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "list guest vlan by vnet", + "length": 255, + "name": "vnet", + "required": false, + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - {}, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the zone name of the guest VLAN range", + "name": "zonename", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "date the guest VLAN was taken", + "name": "taken", + "type": "date" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the account of the guest VLAN range", + "name": "account", + "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the physical network ID of the guest VLAN range", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the guest VLAN", + "name": "vlan", + "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the project name of the guest VLAN range", + "name": "project", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the zone ID of the guest VLAN range", + "name": "zoneid", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the project id of the guest VLAN range", + "name": "projectid", "type": "string" }, - {}, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "true if the guest VLAN is dedicated to the account", + "name": "isdedicated", "type": "boolean" }, { - "description": "the storage pool type", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -3681,558 +2730,526 @@ var preCache = `{ "type": "integer" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the physical network name of the guest VLAN range", + "name": "physicalnetworkname", "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, + "description": "the guest VLAN id", "name": "id", - "related": "createGuestNetworkIpv6Prefix,listGuestNetworkIpv6Prefixes", - "required": true, - "type": "uuid" - } - ], - "response": [ + "type": "long" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the guest VLAN range", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the allocation state of the guest VLAN", + "name": "allocationstate", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the list of networks who use this guest VLAN", + "name": "network", + "type": "list" }, + {}, {} ], - "since": "4.17.0.0" + "since": "4.17.0" }, { - "description": "Updates a storage pool.", + "description": "Updates resource limits for an account or domain.", "isasync": false, - "name": "updateStoragePool", + "name": "updateResourceLimit", "params": [ { - "description": "Change the name of the storage pool", + "description": "Update resource for a specified account. Must be used with the domainId parameter.", "length": 255, - "name": "name", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "account", "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", + "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. 5 - Project. Number of projects a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "resourcetype", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "IOPS CloudStack can provision from this storage pool", + "description": " Maximum resource limit.", "length": 255, - "name": "capacityiops", + "name": "max", "required": false, "type": "long" }, { - "description": "the URL of the storage pool", + "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": "url", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "since": "4.19.0", - "type": "string" + "type": "uuid" }, { - "description": "false to disable the pool for allocation of new volumes, true to enable it back.", + "description": "Update resource limits for project", "length": 255, - "name": "enabled", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "bytes CloudStack can provision from this storage pool", + "description": "Tag for the resource type", "length": 255, - "name": "capacitybytes", + "name": "tag", "required": false, - "type": "long" + "since": "4.20.0", + "type": "string" } ], - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "related": "listResourceLimits", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the account of the resource limit", + "name": "account", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the project name of the resource limit", + "name": "project", "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", + "description": "The tag for the resource limit", + "name": "tag", "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": "the domain ID of the resource limit", + "name": "domainid", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "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": "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": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the domain name of the resource limit", + "name": "domain", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the resource limit belongs", + "name": "domainpath", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "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 state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the project id of the resource limit", + "name": "projectid", + "type": "string" }, - {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Removes an existing GUI theme.", + "isasync": false, + "name": "removeGuiTheme", + "params": [ { - "description": "the ID of the storage pool", + "description": "The unique identifier of the GUI theme to be removed.", + "length": 255, "name": "id", + "related": "listGuiThemes,updateGuiTheme,createGuiTheme,removeGuiTheme", + "required": true, + "type": "uuid" + } + ], + "related": "listGuiThemes,updateGuiTheme,createGuiTheme", + "response": [ + { + "description": "Description of the GUI theme.", + "name": "description", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "ID of the custom GUI theme.", + "name": "id", + "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "domainids", + "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "jsonconfiguration", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "When the GUI theme was removed.", + "name": "removed", + "type": "date" }, + {}, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", + "name": "ispublic", + "type": "boolean" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "Name of the GUI theme.", + "name": "name", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "accountids", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "When the GUI theme was created.", + "name": "created", + "type": "date" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "name": "commonnames", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "css", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "Whether to consider the subdomains of the informed domain IDs.", + "name": "recursivedomains", + "type": "boolean" }, + {}, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], - "since": "3.0.0" + "since": "4.21.0.0" }, { - "description": "Reboots a system VM.", + "description": "Deletes a static route", "isasync": true, - "name": "rebootSystemVm", + "name": "deleteStaticRoute", "params": [ { - "description": "The ID of the system virtual machine", + "description": "the ID of the static route", "length": 255, "name": "id", - "related": "destroySystemVm,listSystemVms,migrateSystemVm,rebootSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "related": "createStaticRoute,listStaticRoutes", "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": [ + } + ], + "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", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {} + ] + }, + { + "description": "get load balancer certificate", + "isasync": false, + "name": "getLoadBalancerSslCertificate", + "params": [ { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, + "description": "the ID of Lb", + "length": 255, + "name": "id", + "related": "getLoadBalancerSslCertificate", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, { - "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.", + "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "crt", + "name": "crt", "type": "string" }, + {}, { - "description": "the ID of the system VM", - "name": "id", + "description": "chain", + "name": "chain", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "key", + "name": "key", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Destroys a l2tp/ipsec remote access vpn", + "isasync": true, + "name": "deleteRemoteAccessVpn", + "params": [ { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" - }, + "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": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if operation is executed successfully", + "name": "success", "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": "Start rolling maintenance", + "isasync": true, + "name": "startRollingMaintenance", + "params": [ { - "description": "the systemvm agent version", - "name": "version", + "description": "the command to execute while hosts are on maintenance", + "length": 255, + "name": "payload", + "required": false, "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", - "type": "string" + "description": "optional operation timeout (in seconds) that overrides the global timeout setting", + "length": 255, + "name": "timeout", + "required": false, + "type": "integer" }, - {}, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" + "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 public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "the IDs of the pods to start maintenance on", + "length": 255, + "name": "podids", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "list" }, { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" + "description": "if rolling mechanism should continue in case of an error", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" + "description": "the IDs of the hosts to start maintenance on", + "length": 255, + "name": "hostids", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "required": false, + "type": "list" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", - "type": "string" - }, + "description": "the IDs of the clusters to start maintenance on", + "length": 255, + "name": "clusterids", + "related": "addCluster,listClusters,updateCluster", + "required": false, + "type": "list" + } + ], + "related": "", + "response": [ { - "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": "indicates if the rolling maintenance operation was successful", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "in case of failure, details are displayed", + "name": "details", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "the hosts updated", + "name": "hostsupdated", + "response": [ + { + "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": "the ID of the updated host", + "name": "hostid", + "type": "string" + }, + { + "description": "end date of the update on the host", + "name": "enddate", + "type": "string" + } + ], + "type": "list" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "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": "Lists Tungsten-Fabric tags", + "description": "list Tungsten-Fabric application policy set", "isasync": false, - "name": "listTungstenFabricTag", + "name": "listTungstenFabricApplicationPolicySet", "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", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric vm", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "vmuuid", + "name": "applicationpolicysetuuid", "required": false, "type": "string" }, @@ -4245,1071 +3262,1249 @@ var preCache = `{ "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric network", - "length": 255, - "name": "networkuuid", - "required": false, - "type": "string" - }, - { - "description": "the uuid of Tungsten-Fabric tag", + "description": "", "length": 255, - "name": "taguuid", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric nic", + "description": "List by keyword", "length": 255, - "name": "nicuuid", + "name": "keyword", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], - "related": "createTungstenFabricTag,applyTungstenFabricTag,removeTungstenFabricTag", + "related": "createTungstenFabricApplicationPolicySet", "response": [ { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", + "type": "string" }, - {}, { - "description": "list Tungsten-Fabric policy", - "name": "policy", + "description": "list Tungsten-Fabric tag", + "name": "tag", "type": "list" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Import LDAP users", - "isasync": false, - "name": "importLdapUsers", + "description": "Updates network ACL list", + "isasync": true, + "name": "updateNetworkACLList", "params": [ { - "description": "List by keyword", + "description": "an optional field, whether to the display the list to the end user or not", "length": 255, - "name": "keyword", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "Creates the account under the specified role.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "customid", "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "the ID of the network ACL", + "length": 255, + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", + "required": true, "type": "uuid" }, { - "description": "", + "description": "Name of the network ACL list", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "details for account used to store specific parameters", + "description": "Description of the network ACL list", "length": 255, - "name": "accountdetails", + "name": "description", "required": false, - "type": "map" + "type": "string" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "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" + }, + {} + ], + "since": "4.4" + }, + { + "description": "Restore a VM to original template/ISO or new template/ISO", + "isasync": true, + "name": "restoreVirtualMachine", + "params": [ + { + "description": "an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO", "length": 255, - "name": "timezone", + "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": "string" + "type": "uuid" }, { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "Optional field to expunge old root volume after restore.", "length": 255, - "name": "account", + "name": "expunge", "required": false, - "type": "string" + "since": "4.19.1", + "type": "boolean" }, { - "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", + "description": "Override root volume's diskoffering.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, + "since": "4.19.1", "type": "uuid" }, { - "description": "", + "description": "Virtual Machine ID", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.", + "description": "used to specify the custom parameters", "length": 255, - "name": "group", + "name": "details", "required": false, - "type": "string" + "since": "4.19.1", + "type": "map" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "Override root volume's size (in GB). Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", "length": 255, - "name": "accounttype", + "name": "rootdisksize", "required": false, - "type": "integer" + "since": "4.19.1", + "type": "long" } ], - "related": "searchLdap,listLdapUsers", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "response": [ { - "description": "The user's username", - "name": "username", + "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 user's email", - "name": "email", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "The user's domain", - "name": "domain", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "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": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, - {}, { - "description": "The user's firstname", - "name": "firstname", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "The user's principle", - "name": "principal", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, - {}, { - "description": "The user's lastname", - "name": "lastname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "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 name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, { - "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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 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 total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the state of the domain", - "name": "state", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, + {}, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "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 network domain", - "name": "networkdomain", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, - {}, - {}, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, + {}, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the name of the domain", - "name": "name", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, + {}, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "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", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "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": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "list networks by ID", - "length": 255, + "description": "the ID of the virtual machine", "name": "id", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "true if network is system, false otherwise", - "length": 255, - "name": "issystem", - "required": false, - "type": "boolean" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the ID or VID of the network", - "length": 255, - "name": "vlan", - "required": false, - "since": "4.17.0", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "type": "boolean" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "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, + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the type of the network. Supported values are: isolated, l2, shared and all", - "length": 255, - "name": "type", - "required": false, + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "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, + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the network belongs to VPC", - "length": 255, - "name": "forvpc", - "required": false, - "type": "boolean" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the zone ID of the network", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "list networks supporting certain services", - "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "list networks by ACL (access control list) type. Supported values are account and domain", - "length": 255, - "name": "acltype", - "required": false, - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "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 another user. * all : all networks (account, domain and shared).", - "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", + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + } + ], "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", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Instance lease duration in days", + "name": "leaseduration", "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "state of the network", - "name": "state", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the list of services", - "name": "service", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the list of capabilities", - "name": "capability", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "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" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "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 project id of the group", + "name": "projectid", + "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 domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the capability value", + "description": "tag value", "name": "value", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the capability name", - "name": "name", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the service provider name", - "name": "provider", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "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": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the provider name", - "name": "name", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the service name", - "name": "name", + "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the 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": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" } ], - "type": "list" + "type": "set" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the pool type of the virtual machine", + "name": "pooltype", "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", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -5318,18 +4513,18 @@ var preCache = `{ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -5338,140 +4533,162 @@ var preCache = `{ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], - "type": "list" - }, - { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "type": "set" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "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": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, - {}, { - "description": "the name of the network", - "name": "name", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" - }, - { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, + } + ], + "since": "3.0.0" + }, + { + "description": " delete a nicira nvp device", + "isasync": true, + "name": "deleteNiciraNvpDevice", + "params": [ { - "description": "the network's gateway", - "name": "gateway", - "type": "string" - }, + "description": "Nicira device ID", + "length": 255, + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {} + ] + }, + { + "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": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "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 displaytext of the network", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - } + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {} ] }, { - "description": "List dedicated zones.", + "description": "List ucs blades", "isasync": false, - "name": "listDedicatedZones", + "name": "listUcsBlades", "params": [ { "description": "", @@ -5481,35 +4698,19 @@ var preCache = `{ "type": "integer" }, { - "description": "the ID of the Zone", + "description": "ucs manager id", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", + "required": true, "type": "uuid" }, { - "description": "the name of the account associated with the zone. Must be used with domainId.", + "description": "", "length": 255, - "name": "account", + "name": "page", "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" + "type": "integer" }, { "description": "List by keyword", @@ -5517,25 +4718,13 @@ var preCache = `{ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], - "related": "dedicateZone", + "related": "associateUcsProfileToBlade", "response": [ { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", - "type": "string" - }, - { - "description": "the Name of the Zone", - "name": "zonename", + "description": "ucs blade dn", + "name": "bladedn", "type": "string" }, {}, @@ -5545,23 +4734,23 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "ucs blade id", + "name": "id", "type": "string" }, { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", + "description": "cloudstack host id this blade associates to", + "name": "hostid", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "ucs manager id", + "name": "ucsmanagerid", "type": "string" }, {}, @@ -5573,914 +4762,729 @@ var preCache = `{ ] }, { - "description": "Lists the pools of elastistor", + "description": "Get Volume Snapshot Details", "isasync": false, - "name": "listElastistorPool", + "name": "getVolumeSnapshotDetails", "params": [ { - "description": "the ID of the Pool", + "description": "CloudStack Snapshot UUID", "length": 255, - "name": "id", - "required": false, - "type": "long" + "name": "snapshotid", + "required": true, + "type": "string" } ], - "related": "", + "related": "getVolumeiScsiName", "response": [ { - "description": "the name of the storage pool", - "name": "name", + "description": "Volume iSCSI Name", + "name": "volumeiScsiName", "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", + "description": "Updates an OS category", + "isasync": false, + "name": "updateOsCategory", "params": [ { - "description": "The new ending IP address.", + "description": "Name for the OS category", "length": 255, - "name": "newendip", + "name": "name", "required": false, "type": "string" }, { - "description": "The current starting IP address.", + "description": "Whether the category is featured or not", "length": 255, - "name": "currentstartip", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": true, - "type": "string" + "name": "isfeatured", + "required": false, + "type": "boolean" }, { - "description": "The new starting IP address.", + "description": "sort key of the OS category for listing", "length": 255, - "name": "newstartip", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { - "description": "UUID of POD, where the IP range belongs to.", + "description": "ID of the OS category", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "listOsCategories,addOsCategory,updateOsCategory", "required": true, "type": "uuid" - }, - { - "description": "The current ending IP address.", - "length": 255, - "name": "currentendip", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": true, - "type": "string" } ], + "related": "listOsCategories,addOsCategory", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the OS category", + "name": "id", "type": "string" }, - {}, + { + "description": "Date when the OS category was created.", + "name": "created", + "type": "date" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + { + "description": "the name of the OS category", + "name": "name", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "Whether the OS category is featured", + "name": "isfeatured", + "type": "boolean" } ], - "since": "4.16.0.0" + "since": "4.21.0" }, { - "description": "list Tungsten-Fabric LB health monitor", + "description": "Updates a host.", "isasync": false, - "name": "listTungstenFabricLBHealthMonitor", + "name": "updateHost", "params": [ { - "description": "List by keyword", + "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": "keyword", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "", + "description": "the new uri for the secondary storage: nfs://host/path", "length": 255, - "name": "page", + "name": "url", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "the id of Os category to update the host with", "length": 255, - "name": "pagesize", + "name": "oscategoryid", + "related": "listOsCategories,addOsCategory", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of lb rule", + "description": "the ID of the host to update", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", "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": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "length": 255, + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" }, { - "description": "the health monitor UUID", - "name": "uuid", + "description": "Change the name of host", + "length": 255, + "name": "name", + "required": false, + "since": "4.15", "type": "string" }, { - "description": "the health monitor timeout", - "name": "timeout", - "type": "int" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "length": 255, + "name": "istagarule", + "required": false, + "type": "boolean" }, { - "description": "the health monitor expected code", - "name": "expectedcode", + "description": "Add an annotation to this host", + "length": 255, + "name": "annotation", + "required": false, + "since": "4.11", "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, + "description": "list of tags to be added to the host", + "length": 255, + "name": "hosttags", + "required": false, + "type": "list" + } + ], + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "response": [ { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the health monitor ID", - "name": "id", - "type": "long" - }, - { - "description": "the health monitor retry", - "name": "retry", - "type": "int" + "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 health monitor url path", - "name": "urlpath", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, - {}, { - "description": "the health monitor http method", - "name": "httpmethod", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the health monitor interval", - "name": "interval", - "type": "int" - }, - {}, - { - "description": "the health monitor type", - "name": "type", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "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", + "description": "the resource state of the host", + "name": "resourcestate", "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 amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "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": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "the state of the rule", - "name": "state", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "GPU cards present in the host", + "name": "gpugroup", "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", + "description": "GPU cards present in the host", + "name": "gpugroupname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "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": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + } + ], + "type": "list" } ], "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": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the admin that annotated this host", + "name": "username", "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", + "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": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "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", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the management server name of the host", + "name": "managementservername", "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": "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": "the state of the host", + "name": "state", + "type": "status" + }, { - "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": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "name of the account to be removed from the project", - "length": 255, - "name": "account", - "required": true, + "description": "the name of the host", + "name": "name", "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 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name of the host", + "name": "podname", "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": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, {}, - {} - ] - }, - { - "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": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "UUID of the Guest OS", - "length": 255, - "name": "id", - "related": "listOsTypes,addGuestOs,updateGuestOs", - "required": true, - "type": "uuid" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "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": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "is the guest OS visible for the users", - "name": "fordisplay", - "type": "boolean" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, - {}, { - "description": "the ID of the OS type", - "name": "id", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, {}, { - "description": "the ID of the OS category", - "name": "oscategoryid", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the name of the OS category", - "name": "oscategoryname", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the name of the OS type", - "name": "name", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the name/description of the OS type", - "name": "description", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "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, + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "list guest vlan by id", - "length": 255, - "name": "id", - "required": false, - "type": "long" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "list guest vlan by physical network", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "list guest vlan by zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "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", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, - {}, { - "description": "the project name of the guest VLAN range", - "name": "project", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the zone name of the guest VLAN range", - "name": "zonename", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, - {}, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the physical network name of the guest VLAN range", - "name": "physicalnetworkname", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, { - "description": "the physical network ID of the guest VLAN range", - "name": "physicalnetworkid", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the guest VLAN id", - "name": "id", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the zone ID of the guest VLAN range", + "description": "the Zone ID of the host", "name": "zoneid", "type": "string" }, { - "description": "the project id of the guest VLAN range", - "name": "projectid", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the list of networks who use this guest VLAN", - "name": "network", - "type": "list" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the allocation state of the guest VLAN", - "name": "allocationstate", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "true if the guest VLAN is dedicated to the account", - "name": "isdedicated", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "date the guest VLAN was taken", - "name": "taken", - "type": "date" + "description": "the ID of the host", + "name": "id", + "type": "string" } - ], - "since": "4.17.0" + ] }, { - "description": "Updates resource limits for an account or domain.", - "isasync": false, - "name": "updateResourceLimit", + "description": "Creates a egress firewall rule for a given network ", + "isasync": true, + "name": "createEgressFirewallRule", "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.", + "description": "the ending port of firewall rule", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "endport", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Update resource limits for project", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "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. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "type of the icmp message being sent", "length": 255, - "name": "resourcetype", - "required": true, + "name": "icmptype", + "required": false, "type": "integer" }, { - "description": "Update resource for a specified account. Must be used with the domainId parameter.", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, - "name": "account", + "name": "protocol", + "required": true, + "type": "string" + }, + { + "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": "type of firewallrule: system/user", + "length": 255, + "name": "type", "required": false, "type": "string" }, { - "description": " Maximum resource limit.", + "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "max", + "name": "cidrlist", "required": false, - "type": "long" + "type": "list" + }, + { + "description": "the starting port of firewall rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" + }, + { + "description": "the network id of the port forwarding rule", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "error code for this icmp message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" } ], - "related": "listResourceLimits", + "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", "response": [ { - "description": "the project name of the resource limit", - "name": "project", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { - "description": "the account of the resource limit", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -6489,136 +5493,157 @@ var preCache = `{ "type": "string" }, { - "description": "the domain name of the resource limit", - "name": "domain", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, + {}, { - "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" }, { - "description": "the project id of the resource limit", - "name": "projectid", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "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": "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": "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": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the ending port of firewall rule's port range", + "name": "endport", "type": "integer" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" } ] }, { - "description": "Lists hosts metrics", + "description": "Lists security groups", "isasync": false, - "name": "listHostsMetrics", + "name": "listSecurityGroups", "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", + "description": "list the security group by the id provided", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "required": false, "type": "uuid" }, { - "description": "list hosts for which out-of-band management is enabled", + "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": "outofbandmanagementenabled", + "name": "listall", "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,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" - }, - { - "description": "the id of the host", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -6628,1415 +5653,1819 @@ var preCache = `{ "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]", + "description": "", "length": 255, - "name": "details", + "name": "page", "required": false, - "type": "list" + "type": "integer" }, { - "description": "List by keyword", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "keyword", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "the name of the host", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "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]", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the host type", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "type", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "description": "lists security groups by virtual machine id", "length": 255, - "name": "resourcestate", + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "lists security groups by name", "length": 255, - "name": "hypervisor", + "name": "securitygroupname", "required": false, "type": "string" } ], - "related": "", + "related": "createSecurityGroup,updateSecurityGroup", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total memory allocated in GiB", - "name": "memoryallocatedgb", + "description": "the ID of the security group", + "name": "id", "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 description of the security group", + "name": "description", + "type": "string" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotalgb", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" }, + {}, { "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": "the name of the security group", + "name": "name", + "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocatedghz", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "network write in GiB", - "name": "networkwrite", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, {}, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "the domain name of the security group", + "name": "domain", + "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the project id of the group", + "name": "projectid", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" - }, + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "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" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "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" + } + ], + "type": "set" + } + ] + }, + { + "description": "List OAuth providers registered", + "isasync": false, + "name": "listOauthProvider", + "params": [ { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the ID of the OAuth provider", + "length": 255, + "name": "id", + "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", + "required": false, + "type": "uuid" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" - }, + "description": "Name of the provider", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + } + ], + "related": "verifyOAuthCodeAndGetUser,updateOauthProvider", + "response": [ { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "ID of the provider", + "name": "id", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "Client ID registered in the OAuth provider", + "name": "clientid", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "Name of the provider", + "name": "provider", + "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", + "type": "string" }, + {}, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, + {}, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "Name of the provider", + "name": "name", "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Enables a role", + "isasync": false, + "name": "enableRole", + "params": [ + { + "description": "ID of the role", + "length": 255, + "name": "id", + "related": "createRole,importRole,listRoles,updateRole", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the total memory used in GiB", - "name": "memoryusedgb", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "Delete Service Package", + "isasync": false, + "name": "deleteServicePackageOffering", + "params": [ { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, + "description": "the service offering ID", + "length": 255, + "name": "id", + "related": "registerNetscalerServicePackage,listRegisteredServicePackages", + "required": true, + "type": "string" + } + ], + "response": [ + {}, { - "description": "the total cpu capacity in Ghz", - "name": "cputotalghz", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "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", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Update a Shared FileSystem", + "isasync": false, + "name": "updateSharedFileSystem", + "params": [ { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "createSharedFileSystem,listSharedFileSystems,updateSharedFileSystem,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the description for the shared filesystem.", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "network read in GiB", - "name": "networkread", + "description": "the name of the shared filesystem.", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, + } + ], + "related": "createSharedFileSystem,listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "response": [ { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, + {}, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" }, { - "description": "instances on the host", - "name": "instances", + "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 shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" }, { - "description": "the ID of the host", + "description": "ID of the shared filesystem", "name": "id", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "out-of-band management power state", - "name": "powerstate", - "type": "powerstate" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "the average cpu load the last minute", - "name": "cpuloadaverage", - "type": "double" + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuusedghz", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "GPU cards present in the host", - "name": "gpugroupname", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "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" - } - ], + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" } ], "type": "list" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, { - "description": "system vm instances on the host", - "name": "systeminstances", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", "type": "long" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the project ID of the shared filesystem", + "name": "projectid", "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": "name of the shared filesystem", + "name": "name", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, - {}, { - "description": "key", - "name": "key", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "chain", - "name": "chain", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "crt", - "name": "crt", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "description of the shared filesystem", + "name": "description", "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "Release the dedication for the pod", + "description": "Updates an existing IPv4 subnet for a zone.", "isasync": true, - "name": "releaseDedicatedPod", + "name": "updateIpv4SubnetForZone", "params": [ { - "description": "the ID of the Pod", + "description": "Id of the guest network IPv4 subnet", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,updateIpv4SubnetForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", "required": true, "type": "uuid" + }, + { + "description": "The new CIDR of the IPv4 subnet.", + "length": 255, + "name": "subnet", + "required": true, + "type": "string" } ], + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "type": "string" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" - } - ] - }, - { - "description": "Lists affinity groups", - "isasync": false, - "name": "listAffinityGroups", - "params": [ + }, + {}, { - "description": "lists affinity groups by name", - "length": 255, - "name": "name", - "required": false, + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the project id of the IPv4 subnet", + "name": "projectid", + "type": "string" }, { - "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,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "list the affinity group by the ID provided", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Destroys a system virtual machine.", + "isasync": true, + "name": "destroySystemVm", + "params": [ + { + "description": "The ID of the system virtual machine", "length": 255, "name": "id", - "related": "createAffinityGroup,listAffinityGroups", - "required": false, + "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "required": true, "type": "uuid" - }, + } + ], + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "response": [ { - "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": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "lists affinity groups by type", - "length": 255, - "name": "type", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", "type": "integer" - } - ], - "related": "createAffinityGroup", - "response": [ + }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the ID of the system VM", + "name": "id", + "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, {}, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, - {} - ] - }, - { - "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 public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, - {}, - {}, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" }, { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the agent state of the system VM", + "name": "agentstate", "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, + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "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": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - } - ], - "related": "listSSHKeyPairs", - "response": [ + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the system VM", + "name": "state", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the owner of the keypair", - "name": "account", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, {}, { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "Name of the keypair", + "description": "the systemvm agent version", + "name": "version", + "type": "string" + }, + { + "description": "the name of the system VM", "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" } ] }, { - "description": "Destroys a l2tp/ipsec remote access vpn", - "isasync": true, - "name": "deleteRemoteAccessVpn", + "description": "Archive one or more events.", + "isasync": false, + "name": "archiveEvents", "params": [ { - "description": "public ip address id of the vpn server", + "description": "start date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "name": "startdate", + "required": false, + "type": "date" + }, + { + "description": "end date range to archive 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": "the IDs of the events", + "length": 255, + "name": "ids", + "related": "listEvents", + "required": false, + "type": "list" + }, + { + "description": "archive by event type", + "length": 255, + "name": "type", + "required": false, + "type": "string" } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { - "description": "Start rolling maintenance", - "isasync": true, - "name": "startRollingMaintenance", + "description": "List Autonomous Systems Numbers", + "isasync": false, + "name": "listASNumbers", "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", + "description": "the zone ID", "length": 255, - "name": "forced", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "optional operation timeout (in seconds) that overrides the global timeout setting", + "description": "", "length": 255, - "name": "timeout", + "name": "page", "required": false, "type": "integer" }, { - "description": "the IDs of the clusters to start maintenance on", + "description": "domain id", "length": 255, - "name": "clusterids", - "related": "addCluster,listClusters,updateCluster", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the IDs of the zones to start maintenance on", + "description": "the AS Number range ID", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "asnrangeid", + "related": "createASNRange,listASNRanges", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the command to execute while hosts are on maintenance", + "description": "the vpc id", "length": 255, - "name": "payload", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the IDs of the pods to start maintenance on", + "description": "List by keyword", "length": 255, - "name": "podids", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "keyword", "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", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "the network id", "length": 255, - "name": "pagesize", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "account name", "length": 255, - "name": "keyword", + "name": "account", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "to indicate if the AS number is allocated to any network", "length": 255, - "name": "applicationpolicysetuuid", + "name": "isallocated", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of zone", + "description": "AS number", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "asnumber", + "related": "listASNumbers", "required": false, - "type": "uuid" + "type": "integer" } ], - "related": "createTungstenFabricApplicationPolicySet", + "related": "", "response": [ { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "ID of the AS Number", + "name": "id", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Allocation state", + "name": "allocationstate", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name", + "name": "domain", "type": "string" }, { - "description": "Tungsten-Fabric application policy uuid", - "name": "uuid", + "description": "Network ID", + "name": "associatednetworkid", "type": "string" }, { - "description": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", - "type": "list" + "description": "Account ID", + "name": "accountid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Created Date", + "name": "created", + "type": "date" }, { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" + "description": "AS Number ID", + "name": "asnrangeid", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", + "description": "AS Number", + "name": "asnumber", + "type": "long" + }, + { + "description": "Allocated Date", + "name": "allocated", + "type": "date" + }, + { + "description": "the zone name of the AS Number range", "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": "Domain ID", + "name": "domainid", + "type": "string" }, { - "description": "Name of the network ACL list", - "length": 255, - "name": "name", - "required": false, + "description": "VPC ID", + "name": "vpcid", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Description of the network ACL list", - "length": 255, - "name": "description", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account name", + "name": "account", "type": "string" }, { - "description": "an optional field, whether to the display the list to the end user or not", + "description": "Network Name", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "VPC Name", + "name": "vpcname", + "type": "string" + }, + { + "description": "AS Number Range", + "name": "asnrange", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Deletes a secondary staging store .", + "isasync": false, + "name": "deleteSecondaryStagingStore", + "params": [ + { + "description": "the staging store ID", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", + "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - {} + } ], - "since": "4.4" + "since": "4.2.0" }, { - "description": "Reserve a public IP to an account.", + "description": "List registered userdatas", "isasync": false, - "name": "reserveIpAddress", + "name": "listUserData", "params": [ { - "description": "the ID of the domain to reserve with this IP address", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "keyword", + "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": "the account to reserve with this IP address", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "the ID of the project to reserve with this IP address", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "an optional field, whether to the display the IP to the end user or not", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "fordisplay", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "the ID of the public IP address to reserve", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the Userdata", "length": 255, "name": "id", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, + "related": "listUserData,listCniConfiguration", + "required": false, "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", + "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": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "Userdata name to look for", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, + } + ], + "related": "listCniConfiguration", + "response": [ { "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", + "description": "ID of the User Data", + "name": "id", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the domain name of the User Data owner", + "name": "domain", "type": "string" }, {}, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in the User Data", + "name": "params", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the project id of the User Data", + "name": "projectid", "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", + "description": "path of the domain to which the User Data owner belongs", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "base64 encoded User Data content", + "name": "userdata", "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", + "description": "Name of the User Data", + "name": "name", "type": "string" }, + {}, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the owner id of the User Data", + "name": "accountid", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "the project name of the User Data", + "name": "project", "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", + "description": "the owner of the User Data", + "name": "account", "type": "string" }, { @@ -8045,67 +7474,104 @@ var preCache = `{ "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", + "description": "the domain id of the User Data owner", + "name": "domainid", "type": "string" - }, + } + ], + "since": "4.18" + }, + { + "description": "Updates an internal load balancer", + "isasync": true, + "name": "updateLoadBalancer", + "params": [ { - "description": "is public IP portable across the zones", - "name": "isportable", + "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" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "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": "the account the public IP address is associated with", - "name": "account", - "type": "string" + "description": "the ID of the load balancer", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", + "required": true, + "type": "uuid" + } + ], + "related": "createLoadBalancer,listLoadBalancers", + "response": [ + { + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + }, + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + } + ], + "type": "list" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the list of resource tags associated with ip address", + "description": "the list of resource tags associated with the Load Balancer", "name": "tags", "response": [ + { + "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": "tag key name", "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -8114,8 +7580,18 @@ var preCache = `{ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -8127,122 +7603,203 @@ var preCache = `{ "description": "customer associated with the tag", "name": "customer", "type": "string" + } + ], + "type": "list" + }, + { + "description": "the description of the Load Balancer", + "name": "description", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "the name of the instance", + "name": "name", + "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the state of the instance", + "name": "state", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the instance ID", + "name": "id", "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", + "description": "the domain ID of the Load Balancer", + "name": "domainid", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "the Load Balancer ID", + "name": "id", "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", + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", + "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" - } + }, + {}, + { + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" + }, + { + "description": "the account of the Load Balancer", + "name": "account", + "type": "string" + }, + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + {} ], - "since": "4.17" + "since": "4.4.0" }, { - "description": "Restore a VM to original template/ISO or new template/ISO", + "description": "Scale the service offering for a system vm (console proxy or secondary storage). The system vm must be in a \"Stopped\" state for this command to take effect.", "isasync": true, - "name": "restoreVirtualMachine", + "name": "scaleSystemVm", "params": [ { - "description": "Virtual Machine ID", + "description": "The ID of the system 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,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "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", + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "details", "required": false, + "type": "map" + }, + { + "description": "the service offering ID to apply to the system vm", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, "type": "uuid" } ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the state of the system VM", + "name": "state", "type": "string" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the second DNS for the system VM", + "name": "dns2", + "type": "string" + }, + { + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" + }, + { + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" }, { "description": "the hypervisor on which the template runs", @@ -8250,1121 +7807,703 @@ var preCache = `{ "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "the last disconnected date of host", + "name": "disconnected", "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 name of the system VM", + "name": "name", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { - "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 number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the hostname for the system VM", + "name": "hostname", "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": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, - {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, {}, { - "description": "the project name of the vm", - "name": "project", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" + } + ] + }, + { + "description": "Verify the OAuth Code and fetch the corresponding user from provider", + "isasync": false, + "name": "verifyOAuthCodeAndGetUser", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "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": "Name of the provider", + "length": 255, + "name": "provider", + "required": true, + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "length": 255, + "name": "secretcode", + "required": false, + "type": "string" + } + ], + "related": "updateOauthProvider", + "response": [ + { + "description": "Name of the provider", + "name": "provider", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "ID of the provider", + "name": "id", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "Client ID registered in the OAuth provider", + "name": "clientid", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "Name of the provider", + "name": "name", "type": "string" }, + {}, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "Description of the provider registered", + "name": "description", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "List DRS plans for a clusters", + "isasync": false, + "name": "listClusterDrsPlan", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "ID of the drs plan", + "length": 255, + "name": "id", + "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", + "required": false, + "type": "uuid" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "generateClusterDrsPlan,executeClusterDrsPlan", + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "Status of DRS Plan", + "name": "status", + "type": "status" + }, + { + "description": "unique ID of the drs plan for cluster", + "name": "id", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Id of the cluster", + "name": "clusterid", "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", + "description": "Start event Id of the DRS Plan", + "name": "eventid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, + "description": "List of migrations", + "name": "migrations", + "type": "list" + } + ], + "since": "4.19.0" + }, + { + "description": "Lists clusters.", + "isasync": false, + "name": "listClusters", + "params": [ { - "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": "lists clusters by the cluster ID", + "length": 255, + "name": "id", + "related": "addCluster,listClusters,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "lists clusters by the cluster name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the storage access group", + "length": 255, + "name": "storageaccessgroup", + "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "lists clusters by hypervisor type", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "lists clusters by Zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "lists clusters by Pod ID", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "flag to display the capacity of the clusters", + "length": 255, + "name": "showcapacities", + "required": false, "type": "boolean" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "whether this cluster is managed by cloudstack", + "length": 255, + "name": "managedstate", + "required": false, + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "lists clusters by cluster type", + "length": 255, + "name": "clustertype", + "required": false, "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "CPU arch of the clusters", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20.1", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "lists clusters by allocation state", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" + } + ], + "related": "addCluster,updateCluster", + "response": [ + { + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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 capacity of the Cluster", + "name": "capacity", + "response": [ + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + } + ], + "type": "list" }, + {}, + {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the cluster ID", + "name": "id", "type": "string" }, + {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", + "description": "the Zone name of the cluster", "name": "zonename", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the cluster name", + "name": "name", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Delete one or more events.", + "description": "Lists project invitations and provides detailed information for listed invitations", "isasync": false, - "name": "deleteEvents", + "name": "listProjectInvitations", "params": [ { - "description": "the IDs of the events", + "description": "list invitations by state", "length": 255, - "name": "ids", - "related": "listEvents", + "name": "state", "required": false, - "type": "list" + "type": "string" }, { - "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "", "length": 255, - "name": "enddate", + "name": "pagesize", "required": false, - "type": "date" + "type": "integer" }, { - "description": "start date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", "length": 255, - "name": "startdate", + "name": "activeonly", "required": false, - "type": "date" + "type": "boolean" }, { - "description": "delete by event type", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "type", + "name": "account", "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", + "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": "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", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, "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": "", + "description": "list invitations by id", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listProjectInvitations", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "list invitation by user ID", "length": 255, - "name": "page", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -9374,2206 +8513,1973 @@ var preCache = `{ "type": "string" }, { - "description": "ucs manager id", + "description": "list by project id", "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", - "required": true, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "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": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], - "related": "associateUcsProfileToBlade", + "related": "", "response": [ { - "description": "ucs blade dn", - "name": "bladedn", + "description": "path of the Domain the project belongs to", + "name": "domainpath", "type": "string" }, { - "description": "cloudstack host id this blade associates to", - "name": "hostid", + "description": "the User ID", + "name": "userid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the project", + "name": "projectid", "type": "string" }, { - "description": "ucs manager id", - "name": "ucsmanagerid", + "description": "the name of the project", + "name": "project", "type": "string" }, { - "description": "associated ucs profile dn", - "name": "profiledn", + "description": "the invitation state", + "name": "state", "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", + "description": "the email the invitation was sent to", + "name": "email", "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 account name of the project's owner", + "name": "account", + "type": "string" }, - {}, { "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", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" - } - ] - }, - { - "description": "Get Volume Snapshot Details", - "isasync": false, - "name": "getVolumeSnapshotDetails", - "params": [ + }, { - "description": "CloudStack Snapshot UUID", - "length": 255, - "name": "snapshotid", - "required": true, + "description": "the id of the invitation", + "name": "id", "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", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "3.0.0" }, { - "description": "Deletes an ISO file.", - "isasync": true, - "name": "deleteIso", + "description": "Lists all egress firewall rules for network ID.", + "isasync": false, + "name": "listEgressFirewallRules", "params": [ { - "description": "the ID of the ISO file", + "description": "the network ID for the egress firewall services", "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, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, "type": "uuid" }, { - "description": "the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones", + "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": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "listall", "required": false, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Updates a host.", - "isasync": false, - "name": "updateHost", - "params": [ + "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": "Add an annotation to this host", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "annotation", + "name": "account", "required": false, - "since": "4.11", "type": "string" }, { - "description": "list of tags to be added to the host", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "hosttags", + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable", + "description": "", "length": 255, - "name": "allocationstate", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the new uri for the secondary storage: nfs://host/path", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "url", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "istagarule", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "the id of Os category to update the host with", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "Change the name of host", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "since": "4.15", - "type": "string" + "type": "integer" }, { - "description": "the ID of the host to update", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", "response": [ { - "description": "the name of the host", - "name": "name", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "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 ID of the firewall rule", + "name": "id", + "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the public ip address for the firewall rule", + "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 public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "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": "customer associated with the tag", + "name": "customer", + "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + } + ] + }, + { + "description": "Lists clusters metrics", + "isasync": false, + "name": "listClustersMetrics", + "params": [ + { + "description": "lists clusters by the cluster name", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "lists clusters by cluster type", + "length": 255, + "name": "clustertype", + "required": false, "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "lists clusters by allocation state", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "lists clusters by Zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "CPU arch of the clusters", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20.1", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "whether this cluster is managed by cloudstack", + "length": 255, + "name": "managedstate", + "required": false, + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "lists clusters by Pod ID", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "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": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the name of the storage access group", + "length": 255, + "name": "storageaccessgroup", + "required": false, + "since": "4.21.0", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "flag to display the capacity of the clusters", + "length": 255, + "name": "showcapacities", + "required": false, + "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "lists clusters by the cluster ID", + "length": 255, + "name": "id", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "lists clusters by hypervisor type", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" + }, + { + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, + {}, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "state of the cluster", + "name": "state", + "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the capacity of the Cluster", + "name": "capacity", + "response": [ + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + } + ], + "type": "list" + }, + {}, + { + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the cluster name", + "name": "name", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "running / total hosts in the cluster", + "name": "hosts", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, - {}, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the total cpu used in GiB", + "name": "memoryused", + "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" }, - {}, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the amount of the host's CPU currently used", + "description": "the total cpu used in Ghz", "name": "cpuused", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "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 cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" + }, { - "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": "DRS imbalance for the cluster", + "name": "drsimbalance", + "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", + "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", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", "type": "boolean" }, + {}, { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", - "length": 255, - "name": "protocol", - "required": true, + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "error code for this icmp message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" - }, + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" + } + ], + "since": "4.9.3" + }, + { + "description": "Lists objects at specified path on a storage pool.", + "isasync": false, + "name": "listStoragePoolObjects", + "params": [ { - "description": "the starting port of firewall rule", + "description": "", "length": 255, - "name": "startport", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "type of firewallrule: system/user", + "description": "path to list on storage pool", "length": 255, - "name": "type", + "name": "path", "required": false, "type": "string" }, { - "description": "the ending port of firewall rule", + "description": "", "length": 255, - "name": "endport", + "name": "page", "required": false, "type": "integer" }, { - "description": "the network id of the port forwarding rule", + "description": "List by keyword", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "type of the icmp message being sent", + "description": "id of the storage pool", "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" } ], - "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", + "related": "listImageStoreObjects", "response": [ { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "description": "Is it a directory.", + "name": "isdirectory", "type": "boolean" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "Format of template associated with the data store object.", + "name": "format", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "Volume ID associated with the data store object.", + "name": "volumeid", "type": "string" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "Volume Name associated with the data store object.", + "name": "volumename", "type": "string" }, + {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "Size is in Bytes.", + "name": "size", + "type": "long" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the ending port of firewall rule's port range", - "name": "endport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "Name of the data store object.", + "name": "name", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "list" - }, - {}, - { - "description": "the ID of the firewall rule", - "name": "id", + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "Template Name associated with the data store object.", + "name": "templatename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Template ID associated with the data store object.", + "name": "templateid", + "type": "string" } - ] + ], + "since": "4.19.0" }, { - "description": "Lists VPC offerings", + "description": "Creates a user-defined VM backup schedule", "isasync": false, - "name": "listVPCOfferings", + "name": "createBackupSchedule", "params": [ { - "description": "true if need to list only default VPC offerings. Default value is false", - "length": 255, - "name": "isdefault", - "required": false, - "type": "boolean" - }, - { - "description": "list VPC offerings supporting certain services", - "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" - }, - { - "description": "List by keyword", + "description": "custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28)", "length": 255, - "name": "keyword", - "required": false, + "name": "schedule", + "required": true, "type": "string" }, { - "description": "id of zone VPC offering is associated with", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "uuid" - }, - { - "description": "list VPC offerings by name", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", "length": 255, - "name": "name", - "required": false, + "name": "intervaltype", + "required": true, "type": "string" }, { - "description": "list VPC offerings by id", + "description": "ID of the VM for which schedule is to be defined", "length": 255, - "name": "id", - "related": "updateVPCOffering,listVPCOfferings", - "required": false, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, "type": "uuid" }, { - "description": "list VPC offerings by state", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list VPC offerings by display text", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "length": 255, - "name": "displaytext", - "required": false, + "name": "timezone", + "required": true, "type": "string" }, { - "description": "", + "description": "The maximum number of backups to keep for a VM. If \"0\", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.", "length": 255, - "name": "pagesize", + "name": "maxbackups", "required": false, + "since": "4.21.0", "type": "integer" }, { - "description": "list VPC offerings available for VPC creation in specific domain", + "description": "Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS backup provider. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "quiescevm", "required": false, - "since": "4.18", - "type": "uuid" + "since": "4.21.0", + "type": "boolean" } ], - "related": "updateVPCOffering", + "related": "updateBackupSchedule,listBackups", "response": [ - {}, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "name of the VM", + "name": "virtualmachinename", "type": "string" }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "ID of the VM", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the name of the vpc offering", - "name": "name", + "description": "account id", + "name": "accountid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "zone name", + "name": "zone", + "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "name of the backup", + "name": "name", "type": "string" }, { - "description": "the date this vpc offering was created", + "description": "backup date", "name": "created", "type": "date" }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", - "type": "string" + "description": "backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "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" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "Interval type of the backup", + "name": "intervaltype", + "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "backup type", + "name": "type", "type": "string" }, {}, { - "description": "the id of the vpc offering", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" + "description": "backup offering name", + "name": "backupofferingname", + "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "ID of the VM backup", + "name": "id", "type": "string" }, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "account name", + "name": "account", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "backup size in bytes", + "name": "size", + "type": "long" + }, + { + "description": "description for the backup", + "name": "description", "type": "string" }, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "description": "zone id", + "name": "zoneid", "type": "string" }, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", + "description": "external backup id", + "name": "externalid", "type": "string" - } - ] - }, - { - "description": "Get the SF volume size including Hypervisor Snapshot Reserve", - "isasync": false, - "name": "getSolidFireVolumeSize", - "params": [ + }, { - "description": "Volume UUID", - "length": 255, - "name": "volumeid", - "required": true, + "description": "Lists the vm specific details for the backup", + "name": "vmdetails", + "type": "map" + }, + {}, + { + "description": "domain id", + "name": "domainid", "type": "string" - } - ], - "related": "", - "response": [ + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", - "name": "solidFireVolumeSize", - "type": "long" + "description": "backed up volumes", + "name": "volumes", + "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "domain name", + "name": "domain", + "type": "string" + }, + { + "description": "backup offering id", + "name": "backupofferingid", "type": "string" + }, + { + "description": "backup status", + "name": "status", + "type": "status" + }, + { + "description": "The backup offering corresponding to this backup was removed from the VM", + "name": "vmbackupofferingremoved", + "type": "boolean" } - ] + ], + "since": "4.14.0" }, { - "description": "Uploads a data disk.", - "isasync": true, - "name": "uploadVolume", + "description": "Lists secondary staging stores.", + "isasync": false, + "name": "listSecondaryStagingStores", "params": [ { - "description": "Image store uuid", + "description": "the name of the staging store", "length": 255, - "name": "imagestoreuuid", + "name": "name", "required": false, "type": "string" }, { - "description": "the ID of the zone the volume is to be hosted on", + "description": "the staging store protocol", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "protocol", + "required": false, + "type": "string" }, { - "description": "the checksum value of this volume. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "", "length": 255, - "name": "checksum", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then volume will be assigned to the caller account and domain.", + "description": "the ID of the staging store", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", "required": false, "type": "uuid" }, { - "description": "Upload volume for the project", + "description": "the Zone ID for the staging store", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", + "description": "", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the name of the volume", + "description": "the staging store provider", "length": 255, - "name": "name", - "required": true, + "name": "provider", + "required": false, + "type": "string" + } + ], + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "response": [ + { + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the URL of where the volume is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, + "description": "the protocol of the image store", + "name": "protocol", "type": "string" - } - ], - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "response": [ + }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the name of the image store", + "name": "name", + "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + {}, + { + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + {} + ], + "since": "4.2.0" + }, + { + "description": "Starts a router.", + "isasync": true, + "name": "startRouter", + "params": [ + { + "description": "the ID of the router", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,startRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" + } + ], + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "response": [ + { + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the Pod name for the router", + "name": "podname", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "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": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" } ], "type": "set" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, + {}, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "ID of the disk volume", + "description": "the id of the router", "name": "id", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, + {}, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "name of the disk volume", - "name": "name", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the hostname for the router", + "name": "hostname", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "role of the domain router", + "name": "role", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the template name for the router", + "name": "templatename", + "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + } + ], + "type": "list" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" - }, - {} + } ] }, { - "description": "Lists security groups", + "description": "Resets a configuration. The configuration will be set to default value for global setting, and removed from account_details or domain_details for Account/Domain settings", "isasync": false, - "name": "listSecurityGroups", + "name": "resetConfiguration", "params": [ { - "description": "list the security group by the id provided", + "description": "the ID of the Domain to reset the parameter value for corresponding domain", "length": 255, - "name": "id", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the Zone to reset the parameter value for corresponding zone", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "lists security groups by name", - "length": 255, - "name": "securitygroupname", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the name of the configuration", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "the ID of the Image Store to reset the parameter value for corresponding image store", "length": 255, - "name": "keyword", + "name": "imagestoreid", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", "length": 255, - "name": "listall", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "lists security groups by virtual machine id", + "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the Account to reset the parameter value for corresponding account", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" } ], - "related": "createSecurityGroup,updateSecurityGroup", + "related": "listConfigurations,updateConfiguration", "response": [ { - "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag 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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "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 type of the configuration value", + "name": "type", + "type": "string" }, {}, { - "description": "the project name of the group", - "name": "project", + "description": "the group of the configuration", + "name": "group", "type": "string" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" + "description": "the value of the configuration", + "name": "id", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "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": "id of the resource", - "name": "resourceid", - "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 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" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "the name of the parent configuration", + "name": "parent", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the component of the configuration", + "name": "component", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" + "description": "the category of the configuration", + "name": "category", + "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the default value of the configuration", + "name": "defaultvalue", + "type": "string" }, - {}, { - "description": "the project id of the group", - "name": "projectid", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the display text of the configuration", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the description of the configuration", + "name": "description", + "type": "string" } - ] + ], + "since": "4.16.0" }, { - "description": "Configures a host's out-of-band management interface", - "isasync": false, - "name": "configureOutOfBandManagement", + "description": "Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale vm group.", + "isasync": true, + "name": "createAutoScalePolicy", "params": [ { - "description": "the host management interface IP address", + "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "address", - "required": true, - "type": "string" + "name": "quiettime", + "required": false, + "type": "integer" }, { - "description": "the host management interface port", + "description": "the duration in which the conditions have to be true before action is taken", "length": 255, - "name": "port", + "name": "duration", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the host management interface user", + "description": "the name of the autoscale policy", "length": 255, - "name": "username", - "required": true, + "name": "name", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the host management interface password", + "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, - "name": "password", + "name": "conditionids", + "related": "createCondition,listConditions", "required": true, - "type": "string" + "type": "list" }, { - "description": "the host management interface driver, for example: ipmitool", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", "length": 255, - "name": "driver", + "name": "action", "required": true, "type": "string" - }, - { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" } ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,disableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "response": [ { - "description": "the ID of the host", - "name": "hostid", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, - {}, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the project id autoscale policy", + "name": "projectid", + "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", "type": "integer" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, { - "description": "the operation result description", - "name": "description", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, - {}, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the domain ID of the autoscale policy", + "name": "domainid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" - } - ], - "since": "4.9.0" + }, + {} + ] }, { - "description": "List OAuth providers registered", + "description": "Removes stratosphere ssp server", "isasync": false, - "name": "listOauthProvider", + "name": "deleteStratosphereSsp", "params": [ { - "description": "List by keyword", + "description": "the host ID of ssp server", "length": 255, - "name": "keyword", - "required": false, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Name of the provider", - "length": 255, - "name": "provider", - "required": false, - "type": "string" - }, - { - "description": "the ID of the OAuth provider", - "length": 255, - "name": "id", - "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "verifyOAuthCodeAndGetUser,updateOauthProvider", - "response": [ - { - "description": "Name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", - "type": "string" - }, - { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -11581,268 +10487,138 @@ var preCache = `{ "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "ID of the provider", - "name": "id", - "type": "string" - }, - { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", - "type": "boolean" - }, - { - "description": "Description of the provider registered", - "name": "description", - "type": "string" - }, - {}, - { - "description": "Name of the provider", - "name": "name", - "type": "string" - }, - { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", - "type": "string" - } - ], - "since": "4.19.0" + {} + ] }, { - "description": "Lists storage tags", + "description": "Lists Usage Server metrics", "isasync": false, - "name": "listStorageTags", - "params": [ - { - "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" - } - ], + "name": "listUsageServerMetrics", + "params": [], "related": "", "response": [ { - "description": "the name of the storage tag", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the usage server", + "name": "state", + "type": "state" }, { - "description": "the ID of the storage tag", - "name": "id", - "type": "string" + "description": "the last time this Usage Server checked for jobs", + "name": "lastheartbeat", + "type": "date" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the pool ID of the storage tag", - "name": "poolid", - "type": "long" + "description": "the last time a usage job successfully completed", + "name": "lastsuccessfuljob", + "type": "date" }, - {} - ] - }, - { - "description": "Delete Service Package", - "isasync": false, - "name": "deleteServicePackageOffering", - "params": [ - { - "description": "the service offering ID", - "length": 255, - "name": "id", - "related": "registerNetscalerServicePackage,listRegisteredServicePackages", - "required": true, - "type": "string" - } - ], - "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the active usage server", + "name": "hostname", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" } - ] + ], + "since": "4.17.0" }, { - "description": "Delete VM Schedule.", - "isasync": false, - "name": "deleteVMSchedule", + "description": "Enables HA for a zone", + "isasync": true, + "name": "enableHAForZone", "params": [ { - "description": "ID of VM schedule", - "length": 255, - "name": "id", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", - "required": false, - "type": "uuid" - }, - { - "description": "ID of VM", + "description": "ID of the zone", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" - }, - { - "description": "IDs of VM schedule", - "length": 255, - "name": "ids", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", - "required": false, - "type": "list" } ], "response": [ - {}, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "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.19.0" + "since": "4.11" }, { - "description": "List template visibility and all accounts that have permissions to view this template.", - "isasync": false, - "name": "listTemplatePermissions", - "params": [ - { - "description": "the template ID", - "length": 255, - "name": "id", - "related": "listIsoPermissions,listTemplatePermissions,listTemplatePermissions,listIsoPermissions", - "required": true, - "type": "uuid" - } - ], - "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", + "description": "Cleanups VM reservations in the database.", + "isasync": true, + "name": "cleanVMReservations", + "params": [], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the list of projects the template is available for", - "name": "projectids", - "type": "list" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - { - "description": "the list of accounts the template is available for", - "name": "account", - "type": "list" - }, { "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 template ID", - "name": "id", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, { - "description": "Lists annotations.", + "description": "Lists object storage pools.", "isasync": false, - "name": "listAnnotations", + "name": "listObjectStoragePools", "params": [ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, - { - "description": "the id of the annotation", - "length": 255, - "name": "id", - "required": false, - "type": "string" - }, { "description": "List by keyword", "length": 255, @@ -11850,196 +10626,157 @@ var preCache = `{ "required": false, "type": "string" }, - { - "description": "possible values are \"self\" and \"all\". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can access", - "length": 255, - "name": "annotationfilter", - "required": false, - "since": "4.16.0", - "type": "string" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the entity type", + "description": "the name of the object store", "length": 255, - "name": "entitytype", + "name": "name", "required": false, "type": "string" }, { - "description": "optional: the id of the user of the annotation", + "description": "the object store provider", "length": 255, - "name": "userid", + "name": "provider", "required": false, - "since": "4.16.0", "type": "string" }, { - "description": "the id of the entity for which to show annotations", + "description": "the ID of the storage pool", "length": 255, - "name": "entityid", + "name": "id", + "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "addAnnotation,removeAnnotation,updateAnnotationVisibility", + "related": "addObjectStoragePool,updateObjectStoragePool", "response": [ { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the ID of the object store", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "the url of the object store", + "name": "url", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", - "type": "string" + "description": "the total size of the object store", + "name": "storagetotal", + "type": "long" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", - "type": "string" + "description": "the object store currently used size", + "name": "storageused", + "type": "long" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the name of the object store", + "name": "name", "type": "string" }, {}, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" - }, - { - "description": "the contents of the annotation", - "name": "annotation", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the provider name of the object store", + "name": "providername", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the allocated size of the object store", + "name": "storageallocated", + "type": "long" } ], - "since": "4.11" + "since": "4.19.0" }, { - "description": "Destroys a system virtual machine.", + "description": "Updates Routing firewall rule with specified ID", "isasync": true, - "name": "destroySystemVm", + "name": "updateRoutingFirewallRule", "params": [ { - "description": "The ID of the system virtual machine", + "description": "an optional field, whether to the display the Routing firewall rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "type": "boolean" + }, + { + "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": "the ID of the Routing firewall rule", "length": 255, "name": "id", - "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", "required": true, "type": "uuid" } ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", "response": [ { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" - }, - { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" - }, - {}, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "is firewall for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" - }, - { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { @@ -12048,228 +10785,185 @@ var preCache = `{ "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" - }, - { - "description": "the ID of the system VM", - "name": "id", - "type": "string" - }, - { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" - }, - { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" - }, - { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, + {}, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" - }, - { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" - }, - { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", - "type": "string" - }, - { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" - }, - { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" - }, - { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "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", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" - }, - { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" } - ] + ], + "since": "4.20.0" }, { - "description": "Adds Swift.", + "description": "create secondary staging store.", "isasync": false, - "name": "addSwift", + "name": "createSecondaryStagingStore", "params": [ { - "description": "the account for swift", + "description": "the scope of the staging store: zone only for now", "length": 255, - "name": "account", + "name": "scope", "required": false, "type": "string" }, { - "description": "the URL for swift", + "description": "the Zone ID for the staging store", "length": 255, - "name": "url", - "required": true, - "type": "string" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the username for swift", + "description": "the staging store provider name", "length": 255, - "name": "username", + "name": "provider", "required": false, "type": "string" }, { - "description": " key for the user for swift", + "description": "the details for the staging store", "length": 255, - "name": "key", + "name": "details", "required": false, + "type": "map" + }, + { + "description": "the URL for the staging store", + "length": 2048, + "name": "url", + "required": true, "type": "string" } ], - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "defines if store is read-only", - "name": "readonly", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" - }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the ID of the image store", - "name": "id", - "type": "string" - }, - { - "description": "the url of the image store", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -12278,9 +10972,9 @@ var preCache = `{ "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { "description": "the Zone ID of the image store", @@ -12288,100 +10982,69 @@ var preCache = `{ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "Archive one or more events.", - "isasync": false, - "name": "archiveEvents", - "params": [ { - "description": "end date range to archive 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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "archive by event type", - "length": 255, - "name": "type", - "required": false, + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "start date range to archive 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": "the protocol of the image store", + "name": "protocol", + "type": "string" }, { - "description": "the IDs of the events", - "length": 255, - "name": "ids", - "related": "listEvents", - "required": false, - "type": "list" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the image store", + "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { - "description": "Deletes a secondary staging store .", + "description": "Remove a VMware datacenter from a zone.", "isasync": false, - "name": "deleteSecondaryStagingStore", + "name": "removeVmwareDc", "params": [ { - "description": "the staging store ID", + "description": "The id of Zone from which VMware datacenter has to be removed.", "length": 255, - "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" } ], "response": [ + {}, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "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", @@ -12389,169 +11052,99 @@ var preCache = `{ "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" } - ], - "since": "4.2.0" + ] }, { - "description": "List registered userdatas", - "isasync": false, - "name": "listUserData", + "description": "Run the custom action", + "isasync": true, + "name": "runCustomAction", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Parameters in key/value pairs using format parameters[i].keyname=keyvalue. Example: parameters[0].endpoint.url=urlvalue", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "parameters", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "Userdata name to look for", + "description": "Type of the resource", "length": 255, - "name": "name", + "name": "resourcetype", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "ID of the instance", "length": 255, - "name": "keyword", - "required": false, + "name": "resourceid", + "required": true, "type": "string" }, { - "description": "the ID of the Userdata", - "length": 255, - "name": "id", - "related": "listUserData", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "ID of the custom action", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, + "name": "customactionid", + "related": "addCustomAction,listCustomActions", + "required": true, "type": "uuid" - }, - { - "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" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "", "response": [ { - "description": "ID of the ssh keypair", - "name": "id", + "description": "Name of the action", + "name": "name", "type": "string" }, + {}, { - "description": "the owner of the userdata", - "name": "account", + "description": "ID of the action", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Whether custom action succeed or not", + "name": "success", "type": "boolean" }, { - "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": "params", - "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": "Name of the userdata", - "name": "name", - "type": "string" - }, - { - "description": "the owner id of the userdata", - "name": "accountid", - "type": "string" - }, - { - "description": "base64 encoded userdata content", - "name": "userdata", - "type": "string" - }, - { - "description": "the domain id of the userdata owner", - "name": "domainid", - "type": "string" - }, {}, { - "description": "the domain name of the userdata owner", - "name": "domain", - "type": "string" + "description": "Result of the action execution", + "name": "result", + "type": "map" } ], - "since": "4.18" + "since": "4.21.0" }, { - "description": "Updates an internal load balancer", + "description": "Updates load balancer health check policy", "isasync": true, - "name": "updateLoadBalancer", + "name": "updateLBHealthCheckPolicy", "params": [ { - "description": "the ID of the load balancer", + "description": "ID of load balancer health check policy", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies,updateLBHealthCheckPolicy", "required": true, "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "an optional field, whether to the display the policy to the end user or not", "length": 255, "name": "fordisplay", "required": false, @@ -12567,450 +11160,727 @@ var preCache = `{ "type": "string" } ], - "related": "createLoadBalancer,listLoadBalancers", + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "Load Balancer network id", - "name": "networkid", - "type": "string" - }, - { - "description": "the description of the Load Balancer", - "name": "description", - "type": "string" - }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - }, - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - }, - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - } - ], - "type": "list" - }, - { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the Load Balancer", + "description": "the domain ID of the HealthCheck policy", "name": "domainid", "type": "string" }, { - "description": "the domain of the Load Balancer", + "description": "the domain of the HealthCheck policy", "name": "domain", "type": "string" }, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", - "type": "string" - }, - { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the name of the Load Balancer", - "name": "name", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", + "description": "the list of healthcheckpolicies", + "name": "healthcheckpolicy", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the description of the healthcheck policy", + "name": "description", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" }, { - "description": "tag key name", - "name": "key", + "description": "the LB HealthCheck policy ID", + "name": "id", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", - "response": [ - { - "description": "the state of the instance", + "description": "the state of the policy", "name": "state", "type": "string" }, { - "description": "the instance ID", - "name": "id", - "type": "string" - }, - { - "description": "the name of the instance", - "name": "name", - "type": "string" - }, - { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" } ], "type": "list" }, { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the account of the Load Balancer", + "description": "the account of the HealthCheck policy", "name": "account", "type": "string" } ], - "since": "4.4.0" + "since": "4.4" }, { - "description": "Scale the service offering for a system vm (console proxy or secondary storage). The system vm must be in a \"Stopped\" state for this command to take effect.", + "description": "remove Tungsten-Fabric policy", "isasync": true, - "name": "scaleSystemVm", + "name": "removeTungstenFabricPolicyRule", "params": [ { - "description": "The ID of the system vm", + "description": "the ID of zone", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "description": "the Uuid of Tungsten-Fabric policy", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "policyuuid", + "required": true, + "type": "string" }, { - "description": "the service offering ID to apply to the system vm", + "description": "the Uuid of Tungsten-Fabric policy rule", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "ruleuuid", "required": true, - "type": "uuid" + "type": "string" } ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", + "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy,removeTungstenFabricPolicy", "response": [ { - "description": "the template name for the system VM", - "name": "templatename", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, + {}, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + } + ] + }, + { + "description": "Creates a load balancer rule", + "isasync": true, + "name": "createLoadBalancerRule", + "params": [ + { + "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", + "length": 255, + "name": "protocol", + "required": false, "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the domain ID associated with the load balancer", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "name of the load balancer rule", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true", + "length": 255, + "name": "openfirewall", + "required": false, "type": "boolean" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "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" + }, + { + "description": "load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, + "name": "algorithm", + "required": true, "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 guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the account associated with the load balancer. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", + "description": "the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed.", + "length": 255, + "name": "cidrlist", + "required": false, + "since": "4.18.0.0", + "type": "list" + }, + { + "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", + "length": 255, + "name": "privateport", + "required": true, "type": "integer" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the public port from where the network traffic will be load balanced from", + "length": 255, + "name": "publicport", + "required": true, + "type": "integer" + }, + { + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", + "required": false, "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "public IP address ID from where the network traffic will be load balanced from", + "length": 255, + "name": "publicipid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" + }, + { + "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "listLoadBalancerRules,updateLoadBalancerRule", + "response": [ + {}, + { + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated with load balancer", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "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" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the public port", + "name": "publicport", + "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, - {}, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the Zone ID for the system VM", + "description": "the public ip address", + "name": "publicip", + "type": "string" + } + ] + }, + { + "description": "Import vSphere storage policies", + "isasync": false, + "name": "importVsphereStoragePolicies", + "params": [ + { + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "listVsphereStoragePolicies", + "response": [ + {}, + { + "description": "the ID of the Zone", "name": "zoneid", "type": "string" }, + { + "description": "the name of the Storage Policy", + "name": "name", + "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 Policy", + "name": "id", + "type": "string" + }, + { + "description": "the description of the Storage Policy", + "name": "description", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the system VM", + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", + "type": "string" + }, + {} + ] + }, + { + "description": "delete a backup repository", + "isasync": false, + "name": "deleteBackupRepository", + "params": [ + { + "description": "ID of the backup repository to be deleted", + "length": 255, "name": "id", + "related": "addBackupRepository,listBackupRepositories", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Disables out-of-band management for a zone", + "isasync": true, + "name": "disableOutOfBandManagementForZone", + "params": [ + { + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,configureOutOfBandManagement,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", + "response": [ + { + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" }, + {}, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the operation result description", + "name": "description", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + } + ], + "since": "4.9.0" + }, + { + "description": "Create VM backup", + "isasync": true, + "name": "createBackup", + "params": [ + { + "description": "ID of the VM", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the backup", + "length": 255, + "name": "name", + "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS backup provider. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.", + "length": 255, + "name": "quiescevm", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "the description for the backup", + "length": 255, + "name": "description", + "required": false, + "since": "4.21.0", "type": "string" } - ] + ], + "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.14.0" }, { - "description": "Lists snapshot policies.", + "description": "Lists all IPv6 firewall rules", "isasync": false, - "name": "listSnapshotPolicies", + "name": "listIpv6FirewallRules", "params": [ { - "description": "", + "description": "Lists ipv6 firewall rule with the specified ID", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", "required": false, - "type": "integer" + "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": "", @@ -13020,98 +11890,134 @@ var preCache = `{ "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "fordisplay", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "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, - "since": "4.4", "type": "boolean" }, { - "description": "List by keyword", + "description": "list ipv6 firewall rules by traffic type - ingress or egress", "length": 255, - "name": "keyword", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "the ID of the snapshot policy", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createSnapshotPolicy,updateSnapshotPolicy,listSnapshotPolicies", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "the ID of the disk volume", + "description": "list ipv6 firewall rules by network ID", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" - } - ], - "related": "createSnapshotPolicy,updateSnapshotPolicy", - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "type": "boolean" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "response": [ + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, {}, { - "description": "is this policy for display to the regular user", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the ID of the snapshot policy", - "name": "id", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { @@ -13120,8 +12026,8 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -13135,13 +12041,13 @@ var preCache = `{ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -13150,226 +12056,204 @@ var preCache = `{ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" } ], - "type": "set" - } - ] - }, - { - "description": "Update site to site vpn customer gateway", - "isasync": true, - "name": "updateVpnCustomerGateway", - "params": [ + "type": "list" + }, + {}, { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", - "length": 255, - "name": "ipsecpsk", - "required": true, + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", - "length": 255, - "name": "ikelifetime", - "required": false, - "type": "long" + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "length": 255, - "name": "splitconnections", - "required": false, - "since": "4.15.1", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "If DPD is enabled for VPN connection", - "length": 255, - "name": "dpd", - "required": false, - "type": "boolean" - }, - { - "description": "Force encapsulation for Nat Traversal", - "length": 255, - "name": "forceencap", - "required": false, - "type": "boolean" + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" }, { - "description": "public ip address id of the customer gateway", - "length": 255, - "name": "gateway", - "required": true, + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "ESP policy of the customer gateway", - "length": 255, - "name": "esppolicy", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", - "length": 255, - "name": "ikeversion", - "required": false, - "since": "4.15.1", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" - }, + } + ] + }, + { + "description": "Stops a system VM.", + "isasync": true, + "name": "stopSystemVm", + "params": [ { - "description": "id of customer gateway", + "description": "The ID of the system virtual machine", "length": 255, "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "required": true, "type": "uuid" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", "length": 255, - "name": "esplifetime", + "name": "forced", "required": false, - "type": "long" - }, + "type": "boolean" + } + ], + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "response": [ { - "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": true, + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "length": 255, - "name": "ikepolicy", - "required": true, + "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": "name of this customer gateway", - "length": 255, - "name": "name", - "required": false, + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - } - ], - "related": "createVpnCustomerGateway,listVpnCustomerGateways", - "response": [ + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" + }, { - "description": "name of the customer gateway", - "name": "name", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" }, + {}, { - "description": "the owner", - "name": "account", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, - {}, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { @@ -13378,199 +12262,227 @@ var preCache = `{ "type": "boolean" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the second DNS for the system VM", + "name": "dns2", + "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the project name", - "name": "project", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, - {}, - { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - } - ] - }, - { - "description": "Verify the OAuth Code and fetch the corresponding user from provider", - "isasync": false, - "name": "verifyOAuthCodeAndGetUser", - "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", - "length": 255, - "name": "secretcode", - "required": false, + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "Name of the provider", - "length": 255, - "name": "provider", - "required": true, + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "updateOauthProvider", - "response": [ - { - "description": "ID of the provider", - "name": "id", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", - "type": "boolean" + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, - {}, { - "description": "Name of the provider", - "name": "provider", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "Description of the provider registered", - "name": "description", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "Name of the provider", - "name": "name", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + } + ] + }, + { + "description": "Deletes an egress firewall rule", + "isasync": true, + "name": "deleteEgressFirewallRule", + "params": [ + { + "description": "the ID of the firewall rule", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } - ], - "since": "4.19.0" + ] }, { - "description": "apply Tungsten-Fabric tag", + "description": "Updates a VPC", "isasync": true, - "name": "applyTungstenFabricTag", + "name": "updateVPC", "params": [ { - "description": "the uuid of vms", + "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC", "length": 255, - "name": "vmuuid", + "name": "sourcenatipaddress", "required": false, - "type": "list" + "since": "4.19", + "type": "string" }, { - "description": "the ID of zone", + "description": "the display text of the VPC", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "displaytext", + "required": false, + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, - "name": "policyuuid", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the uuid of nics", + "description": "the name of the VPC", "length": 255, - "name": "nicuuid", + "name": "name", "required": false, - "type": "list" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "applicationpolicysetuuid", + "name": "publicmtu", "required": false, - "type": "string" + "since": "4.18.0", + "type": "integer" }, { - "description": "the uuid of networks", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "networkuuid", + "name": "customid", "required": false, - "type": "list" + "since": "4.4", + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric tag", + "description": "the id of the VPC", "length": 255, - "name": "taguuid", + "name": "id", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": true, - "type": "string" + "type": "uuid" } ], - "related": "createTungstenFabricTag,removeTungstenFabricTag", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ - {}, + { + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" + }, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -13578,167 +12490,360 @@ var preCache = `{ "type": "string" }, { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", - "type": "string" + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" }, + {}, { - "description": "Tungsten-Fabric provider zone name", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the name of the zone the VPC belongs to", "name": "zonename", "type": "string" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" }, { - "description": "list Tungsten-Fabric network", + "description": "the id of the VPC", + "name": "id", + "type": "string" + }, + { + "description": "the list of networks belongign to the VPC", "name": "network", "type": "list" - } - ] - }, - { - "description": "Updates object storage pool", - "isasync": false, - "name": "updateObjectStoragePool", - "params": [ + }, { - "description": "the name for the object store", - "length": 255, - "name": "name", - "required": false, + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "the url for the object store", - "length": 255, - "name": "url", - "required": false, + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" }, { - "description": "Object Store ID", - "length": 255, - "name": "id", - "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", - "required": true, - "type": "uuid" - } - ], - "related": "addObjectStoragePool,listObjectStoragePools", - "response": [ + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr the VPC", + "name": "cidr", + "type": "string" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, + { + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the url of the object store", - "name": "url", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "the object store currently used size", - "name": "storageused", - "type": "long" + "description": "the owner of the VPC", + "name": "account", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" }, { - "description": "the ID of the object store", - "name": "id", + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "the total size of the object store", - "name": "storagetotal", + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" + }, + { + "description": "AS NUMBER", + "name": "asnumber", "type": "long" }, - {}, { - "description": "the name of the object store", + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the VPC", "name": "name", "type": "string" }, { - "description": "the provider name of the object store", - "name": "providername", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" - } - ], - "since": "4.19.0" + }, + { + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" + }, + {} + ] }, { - "description": "List DRS plans for a clusters", + "description": "List VM Schedules.", "isasync": false, - "name": "listClusterDrsPlan", + "name": "listVMSchedule", "params": [ + { + "description": "ID of VM schedule", + "length": 255, + "name": "id", + "related": "createVMSchedule,listVMSchedule,updateVMSchedule", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "ID of the drs plan", + "description": "Action taken by schedule", "length": 255, - "name": "id", - "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", + "name": "action", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "ID of VM schedule", "length": 255, - "name": "keyword", + "name": "enabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "ID of the cluster", + "description": "List by keyword", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "ID of the VM for which schedule is to be defined", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" } ], - "related": "generateClusterDrsPlan,executeClusterDrsPlan", + "related": "createVMSchedule,updateVMSchedule", "response": [ { "description": "the current status of the latest async job acting on this object", @@ -13746,31 +12851,46 @@ var preCache = `{ "type": "integer" }, {}, + { + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + }, {}, { - "description": "Id of the cluster", - "name": "clusterid", + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" + }, + { + "description": "Cron formatted VM schedule", + "name": "schedule", "type": "string" }, { - "description": "unique ID of the drs plan for cluster", + "description": "the ID of VM schedule", "name": "id", "type": "string" }, { - "description": "Start event Id of the DRS Plan", - "name": "eventid", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" }, { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" + "description": "Action", + "name": "action", + "type": "action" + }, + { + "description": "Description of VM schedule", + "name": "description", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -13778,46 +12898,127 @@ var preCache = `{ "type": "string" }, { - "description": "List of migrations", - "name": "migrations", - "type": "list" + "description": "ID of virtual machine", + "name": "virtualmachineid", + "type": "string" }, - {} + { + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" + } ], "since": "4.19.0" }, { - "description": "This deprecated function used to locks an account. Look for the API DisableAccount instead", - "isasync": false, - "name": "lockAccount", + "description": "Attempts to live patch systemVMs - CPVM, SSVM ", + "isasync": true, + "name": "patchSystemVm", "params": [ { - "description": "Locks the specified account on this domain.", + "description": "If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, + "name": "forced", + "required": false, + "type": "boolean" + }, + { + "description": "patches systemVM - CPVM/SSVM with the specified ID", + "length": 255, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": false, "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Locks the specified account.", + "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" + } + ], + "since": "4.17.0" + }, + { + "description": "Add nodes as workers to an existing CKS cluster. ", + "isasync": true, + "name": "addNodesToKubernetesCluster", + "params": [ + { + "description": "(optional) indicates if the node is marked for manual upgrade and excluded from the Kubernetes cluster upgrade operation", "length": 255, - "name": "account", + "name": "manualupgrade", + "required": false, + "type": "boolean" + }, + { + "description": "comma separated list of (external) node (physical or virtual machines) IDs that need to beadded as worker nodes to an existing managed Kubernetes cluster (CKS)", + "length": 255, + "name": "nodeids", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": true, - "type": "string" + "type": "list" + }, + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster", + "required": true, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "(optional) Vmware only, uses the CKS cluster network VR to mount the CKS ISO", + "length": 255, + "name": "mountcksisoonvr", + "required": false, + "type": "boolean" } ], - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "the name of the role", - "name": "rolename", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the network domain", - "name": "networkdomain", + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" + }, + { + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" + }, + { + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { @@ -13826,564 +13027,643 @@ var preCache = `{ "type": "integer" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", + "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "Minimum size of the cluster", + "name": "minsize", "type": "long" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" + }, + { + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "the state of the account", - "name": "state", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.21.0" + }, + { + "description": "Lists volume metrics", + "isasync": false, + "name": "listVolumesMetrics", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the type of disk volume", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", + "description": "the name of the disk volume", + "length": 255, + "name": "name", + "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" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "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": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.19.1", + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "list volumes by disk offering", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": false, + "since": "4.4", + "type": "uuid" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "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": "the ID of the storage pool, available to ROOT admin only", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.3", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "list volumes on specified host", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "the pod id the disk volume belongs to", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "listsystemvms", + "required": false, + "since": "4.18", + "type": "boolean" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the cluster id the disk volume belongs to", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "the ID of the disk volume", + "length": 255, + "name": "id", + "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "type": "uuid" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "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 boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - } - ], - "type": "list" + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, - {}, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - } - ] - }, - { - "description": "Stops a router.", - "isasync": true, - "name": "stopRouter", - "params": [ + "description": "list only volumes that are encrypted", + "length": 255, + "name": "isencrypted", + "required": false, + "since": "4.19.1", + "type": "boolean" + }, { - "description": "the ID of the router", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,startRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": false, "type": "uuid" }, { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "forced", + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "displayvolume", "required": false, + "since": "4.4", "type": "boolean" + }, + { + "description": "the IDs of the volumes, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "since": "4.9", + "type": "list" } ], - "related": "destroyRouter,listRouters,rebootRouter,startRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "related": "", "response": [ { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, - {}, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - } - ], - "type": "list" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the project name of the address", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "the project name of the vpn", "name": "project", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + {}, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "disk size in GiB", + "name": "sizegb", "type": "string" }, { @@ -14392,388 +13672,428 @@ var preCache = `{ "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "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 list of resource tags associated", + "name": "tags", "response": [ { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "customer associated with the tag", + "name": "customer", "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" } ], "type": "set" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the path of the volume", + "name": "path", "type": "string" }, + {}, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, - {}, { - "description": "the id of the router", - "name": "id", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + } + ], + "since": "4.9.3" + }, + { + "description": "Lists all possible details and their options for a resource type such as a VM or a template", + "isasync": false, + "name": "listDetailOptions", + "params": [ + { + "description": "the UUID of the resource (optional)", + "length": 255, + "name": "resourceid", + "required": false, "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the resource type such as UserVm, Template etc.", + "length": 255, + "name": "resourcetype", + "required": true, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Map of all possible details and their possible list of values", + "name": "details", + "type": "map" }, + {}, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ], + "since": "4.13" + }, + { + "description": "Lists SSL certificates", + "isasync": false, + "name": "listSslCerts", + "params": [ + { + "description": "Project that owns the SSL certificate", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "Load balancer rule ID", + "length": 255, + "name": "lbruleid", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "required": false, + "type": "uuid" + }, + { + "description": "Account ID", + "length": 255, + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "ID of SSL certificate", + "length": 255, + "name": "certid", + "related": "uploadSslCert,listSslCerts", + "required": false, + "type": "uuid" + } + ], + "related": "uploadSslCert", + "response": [ + { + "description": "certificate chain", + "name": "certchain", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the project name of the certificate", + "name": "project", + "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "account for the certificate", + "name": "account", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "SSL certificate ID", + "name": "id", + "type": "string" }, + {}, { - "description": "the template name for the router", - "name": "templatename", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "certificate", + "name": "certificate", "type": "string" }, + {}, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "name", + "name": "name", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, { - "description": "Lists clusters.", + "description": "List private gateways", "isasync": false, - "name": "listClusters", + "name": "listPrivateGateways", "params": [ { - "description": "lists clusters by cluster type", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "clustertype", + "name": "account", "required": false, "type": "string" }, { - "description": "lists clusters by the cluster ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "addCluster,listClusters,updateCluster", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "lists clusters by Zone ID", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists clusters by the cluster name", + "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": "name", + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list gateways by state", + "length": 255, + "name": "state", "required": false, "type": "string" }, { - "description": "flag to display the capacity of the clusters", + "description": "list private gateway by id", "length": 255, - "name": "showcapacities", + "name": "id", + "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "list gateways by vpc", "length": 255, - "name": "managedstate", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -14783,1929 +14103,1620 @@ var preCache = `{ "type": "integer" }, { - "description": "lists clusters by hypervisor type", + "description": "list gateways by vlan", "length": 255, - "name": "hypervisor", + "name": "vlan", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists clusters by Pod ID", + "description": "", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "lists clusters by allocation state", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "allocationstate", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "list gateways by ip address", "length": 255, - "name": "page", + "name": "ipaddress", "required": false, - "type": "integer" + "type": "string" } ], - "related": "addCluster,updateCluster", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", + "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "path of the domain to which the private gateway belongs", + "name": "domainpath", "type": "string" }, { - "description": "the capacity of the Cluster", - "name": "capacity", - "response": [ - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - } - ], - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "Source Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" + }, + { + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "the domain associated with the private gateway", + "name": "domain", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the gateway", + "name": "gateway", + "type": "string" }, { - "description": "the cluster name", - "name": "name", + "description": "the id of the private gateway", + "name": "id", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "the project id of the private gateway", + "name": "projectid", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, - {}, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "zone id of the private gateway", + "name": "zoneid", "type": "string" - } - ] - }, - { - "description": "Deletes project invitation", - "isasync": true, - "name": "deleteProjectInvitation", - "params": [ + }, + {}, { - "description": "id of the invitation", - "length": 255, - "name": "id", - "related": "listProjectInvitations", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the account associated with the private gateway", + "name": "account", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", + "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Lists project invitations and provides detailed information for listed invitations", - "isasync": false, - "name": "listProjectInvitations", + "description": "Update the default Ip of a VM Nic", + "isasync": true, + "name": "updateVmNicIp", "params": [ { - "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", + "description": "the ID of the nic to which you want to assign private IP", "length": 255, - "name": "activeonly", - "required": false, - "type": "boolean" + "name": "nicid", + "related": "listNics", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "Secondary IP Address", "length": 255, - "name": "page", + "name": "ipaddress", "required": false, - "type": "integer" + "type": "string" + } + ], + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "response": [ + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "list invitations by state", - "length": 255, - "name": "state", - "required": false, + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "list invitations by id", - "length": 255, - "name": "id", - "related": "listProjectInvitations", - "required": false, - "type": "uuid" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "list invitation by user ID", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "type": "uuid" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "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": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "list by project id", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "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": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "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" - } - ], - "related": "", - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of the project", - "name": "project", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the invitation state", + "description": "the state of the virtual machine", "name": "state", "type": "string" }, { - "description": "the User ID", - "name": "userid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the account name of the project's owner", - "name": "account", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the id of the project", - "name": "projectid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the email the invitation was sent to", - "name": "email", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the id of the invitation", - "name": "id", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, - {}, - {} - ], - "since": "3.0.0" - }, - { - "description": "create Tungsten-Fabric firewall policy", - "isasync": true, - "name": "createTungstenFabricFirewallPolicy", - "params": [ { - "description": "the uuid of Tungsten-Fabric application policy set", - "length": 255, - "name": "applicationpolicysetuuid", - "required": false, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the sequence of Tungsten-Fabric firewall policy", - "length": 255, - "name": "sequence", - "required": true, - "type": "integer" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "Tungsten-Fabric firewall policy name", - "length": 255, + "description": "the name of the virtual machine", "name": "name", - "required": true, "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "listTungstenFabricFirewallPolicy", - "response": [ - {}, - { - "description": "Tungsten-Fabric firewall policy uuid", - "name": "uuid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "Tungsten-Fabric firewall policy name", - "name": "name", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "list Tungsten-Fabric firewall rule", - "name": "firewallrule", - "type": "list" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" - } - ] - }, - { - "description": "Lists all egress firewall rules for network ID.", - "isasync": false, - "name": "listEgressFirewallRules", - "params": [ - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" }, { - "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": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the network ID for the egress firewall services", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "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 ID of IP address of the firewall services", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "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": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "Guest vm Boot Type", + "name": "boottype", + "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": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "Lists rule with the specified ID.", - "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", - "required": false, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "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": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", - "response": [ + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, - {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, - {}, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "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": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" } ], - "type": "list" - }, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" + "type": "set" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, + {}, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" - } - ] - }, - { - "description": "Updates a region", - "isasync": false, - "name": "updateRegion", - "params": [ - { - "description": "Id of region to update", - "length": 255, - "name": "id", - "required": true, - "type": "integer" }, { - "description": "updates region with this name", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "updates region with this end point", - "length": 255, - "name": "endpoint", - "required": false, + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" - } - ], - "related": "addRegion,listRegions", - "response": [ - {}, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "type": "boolean" - }, - { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" }, { - "description": "the name of the region", - "name": "name", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the region", - "name": "id", - "type": "integer" - }, - { - "description": "the end point of the region", - "name": "endpoint", + "description": "User VM type", + "name": "vmtype", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Deletes traffic type of a physical network", - "isasync": true, - "name": "deleteTrafficType", - "params": [ - { - "description": "traffic type id", - "length": 255, - "name": "id", - "related": "addTrafficType,updateTrafficType", - "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": "3.0.0" - }, - { - "description": "Lists clusters metrics", - "isasync": false, - "name": "listClustersMetrics", - "params": [ { - "description": "whether this cluster is managed by cloudstack", - "length": 255, - "name": "managedstate", - "required": false, + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "lists clusters by the cluster ID", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "lists clusters by cluster type", - "length": 255, - "name": "clustertype", - "required": false, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "lists clusters by Pod ID", - "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "lists clusters by hypervisor type", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "flag to display the capacity of the clusters", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "lists clusters by the cluster name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "lists clusters by Zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "lists clusters by allocation state", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", - "type": "string" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", - "type": "string" - }, - { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", - "type": "string" - }, - { - "description": "state of the cluster", - "name": "state", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, - { - "description": "the cluster ID", - "name": "id", - "type": "string" - }, - { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "running / total hosts in the cluster", - "name": "hosts", - "type": "string" - }, - { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" - }, - { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" - }, - { - "description": "the total cpu used in Ghz", - "name": "cpuused", - "type": "string" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, - { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" - }, - { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" - }, - { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", - "type": "string" - }, - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the total cpu used in GiB", - "name": "memoryused", - "type": "string" - }, - { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", - "type": "string" - }, - {}, - { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" - }, - {}, - { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" - }, - { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the cluster name", - "name": "name", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the capacity of the Cluster", - "name": "capacity", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the capacity name", + "description": "the name of the security group", "name": "name", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the Pod name", - "name": "podname", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } - ], - "since": "4.9.3" - }, - { - "description": "Lists objects at specified path on a storage pool.", - "isasync": false, - "name": "listStoragePoolObjects", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "path to list on storage pool", - "length": 255, - "name": "path", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "id of the storage pool", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" - } - ], - "related": "listImageStoreObjects", - "response": [ - { - "description": "Name of the data store object.", - "name": "name", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "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": "the project id the tag belongs to", + "name": "projectid", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "Size is in Bytes.", - "name": "size", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "Format of template associated with the data store object.", - "name": "format", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "Volume ID associated with the data store object.", - "name": "volumeid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, - {}, - { - "description": "Is it a directory.", - "name": "isdirectory", - "type": "boolean" - }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "Template ID associated with the data store object.", - "name": "templateid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Lists a project's project role permissions", - "isasync": false, - "name": "listProjectRolePermissions", - "params": [ - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": false, - "type": "uuid" }, { - "description": "ID of the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - } - ], - "related": "createProjectRolePermission", - "response": [ - { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, - {}, { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the project role permission", - "name": "id", + "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 description of the role permission", - "name": "description", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the ID of the project", - "name": "projectid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" - } - ], - "since": "4.15.0" - }, - { - "description": "Lists all LDAP configurations", - "isasync": false, - "name": "listLdapConfigurations", - "params": [ - { - "description": "linked domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": false, + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", - "length": 255, - "name": "listall", - "required": false, - "since": "4.13.2", - "type": "boolean" - }, - { - "description": "Port", - "length": 255, - "name": "port", - "required": false, - "type": "integer" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "addLdapConfiguration,deleteLdapConfiguration", - "response": [ - { - "description": "name of the host running the ldap server", - "name": "hostname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "linked domain", - "name": "domainid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, - {} - ], - "since": "4.2.0" - }, - { - "description": "Lists secondary staging stores.", - "isasync": false, - "name": "listSecondaryStagingStores", - "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, + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the Zone ID for the staging store", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the staging store", - "length": 255, - "name": "name", - "required": false, + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the staging store provider", - "length": 255, - "name": "provider", - "required": false, + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the ID of the staging store", - "length": 255, - "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", - "required": false, - "type": "uuid" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the staging store protocol", - "length": 255, - "name": "protocol", - "required": false, + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" - } - ], - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "defines if store is read-only", - "name": "readonly", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, - {}, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "the ID of the image store", - "name": "id", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" - }, - {}, - { - "description": "the name of the image store", - "name": "name", - "type": "string" - }, - { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, - { - "description": "the url of the image store", - "name": "url", - "type": "string" - }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, - { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" - }, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" } - ], - "since": "4.2.0" + ] }, { - "description": "Creates a l2tp/ipsec remote access vpn", + "description": "Starts an existing internal lb vm.", "isasync": true, - "name": "createRemoteAccessVpn", + "name": "startInternalLoadBalancerVM", "params": [ { - "description": "public ip address id of the vpn server", + "description": "the ID of the internal lb vm", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "required": true, "type": "uuid" - }, - { - "description": "an optional domainId for the VPN. 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" - }, - { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", - "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" - }, - { - "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", - "length": 255, - "name": "iprange", - "required": false, - "type": "string" - }, - { - "description": "an optional account for the VPN. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], - "related": "listRemoteAccessVpns,updateRemoteAccessVpn", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, - {}, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, - {}, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - } - ] - }, - { - "description": "Starts a router.", - "isasync": true, - "name": "startRouter", - "params": [ - { - "description": "the ID of the router", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,startRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, - "type": "uuid" - } - ], - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "response": [ { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the version of template", - "name": "version", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, { "description": "the traffic type of the nic", "name": "traffictype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" } ], "type": "set" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { @@ -16714,95 +15725,113 @@ var preCache = `{ "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, {}, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, { "description": "the network domain for the router", "name": "networkdomain", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + } + ], + "type": "list" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, + {}, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the ID of the corresponding guest network", @@ -16810,40 +15839,8 @@ var preCache = `{ "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { @@ -16852,44 +15849,38 @@ var preCache = `{ "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the version of template", + "name": "version", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -16898,460 +15889,317 @@ var preCache = `{ "type": "boolean" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the template name for the router", + "name": "templatename", "type": "string" } ] }, { - "description": "(This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for this command to take effect.", + "description": "Updates a disk offering.", "isasync": false, - "name": "changeServiceForVirtualMachine", + "name": "updateDiskOffering", "params": [ { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "details", + "name": "iopsreadratemax", "required": false, - "type": "map" + "since": "4.15", + "type": "long" }, { - "description": "New minimum number of IOPS for the custom disk offering", + "description": "state of the disk offering", "length": 255, - "name": "miniops", + "name": "state", "required": false, - "since": "4.17", - "type": "long" + "type": "string" }, { - "description": "the service offering ID to apply to the virtual machine", + "description": "the cache mode to use for this disk offering", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "cachemode", + "required": false, + "since": "4.15", + "type": "string" }, { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "maxiops", + "name": "iopswriterate", "required": false, - "since": "4.17", + "since": "4.15", "type": "long" }, { - "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "automigrate", + "name": "displayoffering", "required": false, - "since": "4.17", "type": "boolean" }, { - "description": "The ID of the virtual machine", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "length": 255, + "name": "zoneid", + "required": false, + "since": "4.13", + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopsreadratemaxlength", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", + "required": false, + "since": "4.13", + "type": "string" + }, + { + "description": "updates name of the disk offering with this value", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "bytes write rate of the disk offering", + "length": 255, + "name": "byteswriterate", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "ID of the disk offering", "length": 255, "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": true, "type": "uuid" }, { - "description": "Verify OK to Shrink", + "description": "sort key of the disk offering, integer", "length": 255, - "name": "shrinkok", + "name": "sortkey", "required": false, - "since": "4.17", - "type": "boolean" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ + "type": "integer" + }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "io requests read rate of the disk offering", + "length": 255, + "name": "iopsreadrate", + "required": false, + "since": "4.15", "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", + "length": 255, + "name": "tags", + "required": false, + "since": "4.15", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadrate", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "byteswriteratemaxlength", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "required": false, + "since": "4.15", + "type": "long" }, - {}, - {}, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "updates alternate display text of the disk offering with this value", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - } - ], - "type": "set" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopswriteratemaxlength", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "length": 255, + "name": "byteswriteratemax", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "burst io requests write rate of the disk offering", + "length": 255, + "name": "iopswriteratemax", + "required": false, + "since": "4.15", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "burst bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadratemax", + "required": false, + "since": "4.15", + "type": "long" + } + ], + "related": "createDiskOffering,listDiskOfferings", + "response": [ + { + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "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 key name", - "name": "key", - "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, + {}, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", + "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 pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, + {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", @@ -17359,799 +16207,538 @@ var preCache = `{ "type": "integer" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "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 max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", + "type": "boolean" + }, + { + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "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 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", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "state of the disk offering", + "name": "state", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" + }, + { + "description": "the name of the disk offering", + "name": "name", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" + } + ] + }, + { + "description": "Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", + "isasync": false, + "name": "removeVirtualMachinesFromKubernetesCluster", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the IDs of the VMs to remove from the cluster", + "length": 255, + "name": "virtualmachineids", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "list" }, - {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ], + "since": "4.19.0" + }, + { + "description": "delete Tungsten-Fabric logical router", + "isasync": true, + "name": "deleteTungstenFabricLogicalRouter", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the uuid of Tungsten-Fabric logical router", + "length": 255, + "name": "logicalrouteruuid", + "required": true, "type": "string" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "any text associated with the success or failure", + "name": "displaytext", "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 project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - } - ], - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Reset site to site vpn connection", + "isasync": true, + "name": "resetVpnConnection", + "params": [ { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "an optional account for connection. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + "description": "id of vpn connection", + "length": 255, + "name": "id", + "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", + "required": true, + "type": "uuid" + } + ], + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "response": [ + {}, + {}, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the name of the security group", - "name": "name", - "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 domain associated with the tag", - "name": "domain", - "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": "tag value", - "name": "value", - "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "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" - }, - { - "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": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "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 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 id of the security group rule", - "name": "ruleid", - "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "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" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the domain path of the owner", + "name": "domainpath", "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", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" } ] }, { - "description": "Resets a configuration. The configuration will be set to default value for global setting, and removed from account_details or domain_details for Account/Domain settings", + "description": "Lists Kubernetes clusters", "isasync": false, - "name": "resetConfiguration", + "name": "listKubernetesClusters", "params": [ { - "description": "the ID of the Zone to reset the parameter value for corresponding zone", + "description": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", + "description": "List by keyword", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", + "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": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "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": "the ID of the Image Store to reset the parameter value for corresponding image store", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "required": false, "type": "uuid" }, { - "description": "the name of the configuration", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "the ID of the Account to reset the parameter value for corresponding account", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "clustertype", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "string" }, { - "description": "the ID of the Domain to reset the parameter value for corresponding domain", + "description": "list only resources belonging to the domain specified", "length": 255, "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" - } - ], - "related": "listConfigurations,updateConfiguration", - "response": [ + }, { - "description": "the value of the configuration", - "name": "value", + "description": "state of the Kubernetes cluster", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", + "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 category of the configuration", - "name": "category", - "type": "string" - }, - { - "description": "the name of the configuration", - "name": "name", - "type": "string" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, {}, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { @@ -18160,1354 +16747,1059 @@ var preCache = `{ "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "the component of the configuration", - "name": "component", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the description of the configuration", - "name": "description", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, - {}, { - "description": "the default value of the configuration", - "name": "defaultvalue", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the group of the configuration", - "name": "group", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the value of the configuration", - "name": "id", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", "type": "long" - } - ], - "since": "4.16.0" - }, - { - "description": "Lists all available OS mappings for given hypervisor", - "isasync": false, - "name": "listGuestOsMapping", - "params": [ + }, { - "description": "list Guest OS mapping by OS display name", - "length": 255, - "name": "osdisplayname", - "required": false, + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "list Guest OS mapping by OS mapping name with hypervisor", - "length": 255, - "name": "osnameforhypervisor", - "required": false, + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "list Guest OS mapping by hypervisor", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "list mapping by Guest OS Type UUID", - "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" }, { - "description": "list mapping by its UUID", - "length": 255, - "name": "id", - "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", - "required": false, - "type": "uuid" + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" }, { - "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", - "length": 255, - "name": "hypervisorversion", - "required": false, + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" - } - ], - "related": "addGuestOsMapping,updateGuestOsMapping", - "response": [ + }, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", - "type": "string" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, - {}, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" - } - ], - "since": "4.4.0" - }, - { - "description": "List all public, private, and privileged templates.", - "isasync": false, - "name": "listTemplates", - "params": [ + }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "Public IP Address of the cluster", + "name": "ipaddress", + "type": "string" }, { - "description": "ID of the storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "4.19", - "type": "uuid" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, { - "description": "the template name", - "length": 255, - "name": "name", - "required": false, + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", - "length": 255, - "name": "isvnf", - "required": false, - "since": "4.19.0", - "type": "boolean" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "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 master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the hypervisor for which to restrict the search", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", - "length": 255, - "name": "templatefilter", - "required": true, + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "list templates by zoneId", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" }, { - "description": "the IDs of the templates, mutually exclusive with id", - "length": 255, - "name": "ids", - "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, - "since": "4.9", - "type": "list" + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", + "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" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "ID of the image or image cache store", - "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", - "required": false, - "since": "4.19", - "type": "uuid" + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "keypair details", + "name": "keypair", "type": "string" + } + ] + }, + { + "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", + "isasync": true, + "name": "createAutoScaleVmGroup", + "params": [ + { + "description": "list of scaledown autoscale policies", + "length": 255, + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "list" }, { - "description": "the template ID", + "description": "the frequency in which the performance counters to be collected", "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", + "name": "interval", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "name": "minmembers", + "required": true, + "type": "integer" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", "length": 255, - "name": "details", - "required": false, - "since": "4.15", - "type": "list" + "name": "maxmembers", + "required": true, + "type": "integer" }, { - "description": "list datadisk templates by parent template id", + "description": "the ID of the load balancer rule", "length": 255, - "name": "parenttemplateid", - "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, - "since": "4.4", + "name": "lbruleid", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "required": true, "type": "uuid" }, { - "description": "flag to display the resource image for the templates", + "description": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "showicon", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the type of the template", + "description": "list of scaleup autoscale policies", "length": 255, - "name": "templatetype", - "required": false, - "since": "4.19.0", - "type": "string" + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "list" }, { - "description": "If set to true, list only unique templates across zones", + "description": "the name of the autoscale vmgroup", "length": 255, - "name": "showunique", + "name": "name", "required": false, - "since": "4.13.2", - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the autoscale profile that contains information about the vms in the vm group.", "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "show removed templates as well", - "length": 255, - "name": "showremoved", - "required": false, - "type": "boolean" + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, + "type": "uuid" } ], - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "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 template display text", - "name": "displaytext", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, {}, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the template ID", - "name": "id", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the template name", - "name": "name", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "the tag of this template", - "name": "templatetag", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, + {}, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "is group for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", + "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the load balancer rule ID", + "name": "lbruleid", "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", + "description": "the account owning the vm group", + "name": "account", "type": "string" - }, + } + ] + }, + { + "description": "add a baremetal ping pxe server", + "isasync": true, + "name": "addBaremetalPxePingServer", + "params": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "URL of the external pxe device", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "PING storage server ip", + "length": 255, + "name": "pingstorageserverip", + "required": true, "type": "string" }, - {}, { - "description": "checksum of the template", - "name": "checksum", + "description": "Password of PING storage server", + "length": 255, + "name": "pingcifspassword", + "required": false, "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "Root directory on PING storage server", + "length": 255, + "name": "pingdir", + "required": true, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the 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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "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": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - } - ] - }, - { - "description": "Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale vm group.", - "isasync": true, - "name": "createAutoScalePolicy", - "params": [ - { - "description": "the duration in which the conditions have to be true before action is taken", + "description": "Username of PING storage server", "length": 255, - "name": "duration", - "required": true, - "type": "integer" + "name": "pingcifsusername", + "required": false, + "type": "string" }, { - "description": "the cool down period in which the policy should not be evaluated after the action has been taken", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "quiettime", - "required": false, - "type": "integer" + "name": "tftpdir", + "required": true, + "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "conditionids", - "related": "createCondition,listConditions", + "name": "username", "required": true, - "type": "list" + "type": "string" }, { - "description": "the name of the autoscale policy", + "description": "Pod Id", "length": 255, - "name": "name", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "description": "type of pxe device", "length": 255, - "name": "action", + "name": "pxeservertype", "required": true, "type": "string" } ], - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the autoscale policy ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "PING storage server ip", + "name": "pingstorageserverip", "type": "string" }, { - "description": "name of the autoscale policy", - "name": "name", + "description": "Tftp root directory of PXE server", + "name": "tftpdir", "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" - }, - { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "url", + "name": "url", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Root directory on PING storage server", + "name": "pingdir", "type": "string" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "name of the provider", + "name": "provider", "type": "string" }, - {}, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "device id of ", + "name": "id", "type": "string" }, - { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" - }, - { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", - "type": "integer" - } + {} ] }, { - "description": "Removes stratosphere ssp server", - "isasync": false, - "name": "deleteStratosphereSsp", + "description": "Deletes a load balancer rule.", + "isasync": true, + "name": "deleteLoadBalancerRule", "params": [ { - "description": "the host ID of ssp server", + "description": "the ID of the load balancer rule", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", "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": "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": "create Tungsten-Fabric policy", + "description": "Change the BGP peers for a VPC.", "isasync": true, - "name": "createTungstenFabricPolicy", + "name": "changeBgpPeersForVpc", "params": [ { - "description": "Tungsten-Fabric policy name", + "description": "UUID of the VPC which the Bgp Peers are associated to.", "length": 255, - "name": "name", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the ID of zone", + "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", + "required": false, + "type": "list" } ], - "related": "listTungstenFabricPolicy,removeTungstenFabricPolicyRule,applyTungstenFabricPolicy,removeTungstenFabricPolicy", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", "response": [ + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" + }, + { + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" + }, + { + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, + { + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "the project id of the bgp peer", + "name": "projectid", + "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the domain name of the bgp peer", + "name": "domain", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, - {} - ] - }, - { - "description": "Lists Usage Server metrics", - "isasync": false, - "name": "listUsageServerMetrics", - "params": [], - "related": "", - "response": [ {}, - { - "description": "the state of the usage server", - "name": "state", - "type": "state" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the active usage server", - "name": "hostname", + "description": "password of bgp peer", + "name": "password", "type": "string" }, - {}, { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" + "description": "the account of the bgp peer", + "name": "account", + "type": "string" }, { - "description": "the last time this Usage Server checked for jobs", - "name": "lastheartbeat", - "type": "date" + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "the last time a usage job successfully completed", - "name": "lastsuccessfuljob", + "description": "date when this bgp peer was created.", + "name": "created", "type": "date" } ], - "since": "4.17.0" + "since": "4.20.0" }, { - "description": "Creates a bucket in the specified object storage pool. ", - "isasync": true, - "name": "createBucket", + "description": "list portable IP ranges", + "isasync": false, + "name": "listPortableIpRanges", "params": [ { - "description": "Enable object locking in bucket", - "length": 255, - "name": "objectlocking", - "required": false, - "type": "boolean" - }, - { - "description": "Enable bucket versioning", + "description": "", "length": 255, - "name": "versioning", + "name": "pagesize", "required": false, - "type": "boolean" - }, - { - "description": "the name of the bucket", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "type": "integer" }, { - "description": "Enable bucket encryption", + "description": "Id of a Region", "length": 255, - "name": "encryption", + "name": "regionid", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the domain ID associated with the bucket. If used with the account parameter returns the bucket associated with the account for the specified domain.", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "keyword", "required": false, - "type": "uuid" - }, - { - "description": "Id of the Object Storage Pool where bucket is created", - "length": 255, - "name": "objectstorageid", - "related": "addObjectStoragePool,listObjectStoragePools", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Bucket Quota in GB", + "description": "", "length": 255, - "name": "quota", + "name": "page", "required": false, "type": "integer" }, { - "description": "the project associated with the bucket. Mutually exclusive with account parameter", + "description": "Id of the portable ip range", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createPortableIpRange,listPortableIpRanges", "required": false, "type": "uuid" - }, - { - "description": "the account associated with the bucket. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "The Bucket access policy", - "length": 255, - "name": "policy", - "required": false, - "type": "string" } ], - "related": "listBuckets", + "related": "createPortableIpRange", "response": [ { - "description": "the domain associated with the bucket", - "name": "domain", - "type": "string" - }, - { - "description": "Bucket Encryption", - "name": "encryption", - "type": "boolean" - }, - { - "description": "the account associated with the Bucket", - "name": "account", - "type": "string" - }, - { - "description": "Bucket Access Key", - "name": "accesskey", - "type": "string" - }, - { - "description": "Bucket Access Policy", - "name": "policy", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the date the Bucket was created", - "name": "created", - "type": "date" - }, - { - "description": "ID of the Bucket", - "name": "id", - "type": "string" - }, - { - "description": "Object storage provider", - "name": "provider", - "type": "string" - }, - { - "description": "name of the Bucket", - "name": "name", - "type": "string" + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" }, + {}, { - "description": "Bucket Secret Key", - "name": "usersecretkey", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", + "name": "portableipaddress", "response": [ { - "description": "tag key name", - "name": "key", + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account ID the portable IP address is associated with", + "name": "accountid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "Bucket URL", - "name": "url", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the project name of the bucket", - "name": "project", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "Bucket Versioning", - "name": "versioning", - "type": "boolean" - }, - { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", + "description": "portable IP range ID", + "name": "id", "type": "string" }, - {}, { - "description": "id of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstorageid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" - }, - { - "description": "the project id of the bucket", - "name": "projectid", + "description": "the start ip of the portable IP range", + "name": "startip", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the end ip of the portable IP range", + "name": "endip", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", - "type": "string" - }, - { - "description": "Bucket Object Locking", - "name": "objectlocking", - "type": "boolean" - }, - { - "description": "Bucket Quota in GB", - "name": "quota", - "type": "integer" - }, - { - "description": "State of the Bucket", - "name": "state", - "type": "string" } - ], - "since": "4.19.0" + ] }, { - "description": "Enables HA for a zone", - "isasync": true, - "name": "enableHAForZone", + "description": "Returns user data associated with the VM", + "isasync": false, + "name": "getVirtualMachineUserData", "params": [ { - "description": "ID of the zone", + "description": "The ID of the virtual machine", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], + "related": "", "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", + "description": "Base64 encoded VM user data", + "name": "userdata", "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": "the ID of the virtual machine", + "name": "virtualmachineid", + "type": "string" } ], - "since": "4.11" + "since": "4.4" }, { - "description": "Lists physical networks", + "description": "Updates network permissions.", "isasync": false, - "name": "listPhysicalNetworks", + "name": "createNetworkPermissions", "params": [ { - "description": "the Zone ID for the physical network", + "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "accounts", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "", + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "pagesize", + "name": "accountids", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "integer" + "type": "list" }, { - "description": "list physical network by id", + "description": "the network ID", "length": 255, - "name": "id", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": false, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, "type": "uuid" }, { - "description": "search by name", + "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "name", + "name": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, + "type": "list" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "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": "", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.17.0" + }, + { + "description": "Disables static rule for given IP address", + "isasync": true, + "name": "disableStaticNat", + "params": [ + { + "description": "the public IP address ID for which static NAT feature is being disabled", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" } ], - "related": "createPhysicalNetwork,updatePhysicalNetwork", "response": [ { - "description": "the uuid of the physical network", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "isolation methods", - "name": "isolationmethods", - "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", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Assigns secondary IP to NIC", + "isasync": true, + "name": "addIpToNic", + "params": [ { - "description": "zone name of the physical network", - "name": "zonename", + "description": "Secondary IP Address", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", - "type": "string" - }, + "description": "the ID of the nic to which you want to assign private IP", + "length": 255, + "name": "nicid", + "related": "listNics", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "the ID of the nic", + "name": "nicid", "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "the ID of the network", + "name": "networkid", "type": "string" }, { - "description": "state of the physical network", - "name": "state", + "description": "the ID of the vm", + "name": "virtualmachineid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -19515,427 +17807,420 @@ var preCache = `{ }, {}, { - "description": "name of the physical network", - "name": "name", + "description": "Secondary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "comma separated tag", - "name": "tags", + "description": "the list of Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the secondary private IP addr", + "name": "id", "type": "string" - } - ], - "since": "3.0.0" + }, + {} + ] }, { - "description": "Lists all firewall rules for an IP address.", + "description": "Delete a Ucs manager", "isasync": false, - "name": "listFirewallRules", + "name": "deleteUcsManager", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "ucs manager id", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Deletes a host.", + "isasync": false, + "name": "deleteHost", + "params": [ + { + "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", "length": 255, - "name": "listall", + "name": "forcedestroylocalstorage", "required": false, "type": "boolean" }, { - "description": "", + "description": "the host ID", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" }, { - "description": "List by keyword", + "description": "Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped", "length": 255, - "name": "keyword", + "name": "forced", "required": false, + "type": "boolean" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "list firewall rules for certain network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.3", - "type": "uuid" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - }, + } + ] + }, + { + "description": "deletes the resource icon from the specified resource(s)", + "isasync": false, + "name": "deleteResourceIcon", + "params": [ { - "description": "Lists rule with the specified ID.", + "description": "list of resources to upload the icon/image for", "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", - "required": false, - "type": "uuid" + "name": "resourceids", + "required": true, + "type": "list" }, { - "description": "the ID of IP address of the firewall services", + "description": "type of the resource", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" + "name": "resourcetype", + "required": true, + "type": "string" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], - "related": "createFirewallRule,updateEgressFirewallRule", + "since": "4.16.0.0" + }, + { + "description": "Lists capabilities", + "isasync": false, + "name": "listCapabilities", + "params": [], + "related": "", "response": [ { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" + "description": "time interval (in seconds) to reset api count", + "name": "apilimitinterval", + "type": "integer" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "version of the cloud stack", + "name": "cloudstackversion", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the min Ram size for the service offering used by the shared filesystem instance", + "name": "sharedfsvmminramsize", + "type": "integer" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "The path of the extensions directory", + "name": "extensionspath", "type": "string" }, + {}, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "true if dynamic role-based api checker is enabled, false otherwise", + "name": "dynamicrolesenabled", + "type": "boolean" }, { - "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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "list" + "description": "true if the user can recover and expunge volumes, false otherwise", + "name": "allowuserexpungerecovervolume", + "type": "boolean" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" + "description": "true if users can see all accounts within the same domain, false otherwise", + "name": "allowuserviewalldomainaccounts", + "type": "boolean" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" + "description": "maximum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingmaxsize", + "type": "long" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" + "description": "true if users are allowed to force stop a vm, false otherwise", + "name": "allowuserforcestopvm", + "type": "boolean" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "minimum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingminsize", + "type": "long" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "true if region supports elastic load balancer on basic zones", + "name": "supportELB", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "description": "default page size in the UI for various views, value set in the configurations", + "name": "defaultuipagesize", + "type": "long" + }, + { + "description": "true if user and domain admins can set templates to be shared, false otherwise", + "name": "userpublictemplateenabled", "type": "boolean" }, { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" + "description": "true if snapshot is supported for KVM host, false otherwise", + "name": "kvmsnapshotenabled", + "type": "boolean" + }, + { + "description": "Max allowed number of api requests within the specified interval", + "name": "apilimitmax", + "type": "integer" }, {}, { - "description": "the state of the rule", - "name": "state", + "description": "true if Kubernetes Service plugin is enabled, false otherwise", + "name": "kubernetesserviceenabled", + "type": "boolean" + }, + { + "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", + "name": "allowuserviewdestroyedvm", + "type": "boolean" + }, + { + "description": "Display name for custom hypervisor", + "name": "customhypervisordisplayname", "type": "string" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "the retention time for Instances stats", + "name": "instancesstatsretentiontime", "type": "integer" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if stats are retained for instance disks otherwise false", + "name": "instancesdisksstatsretentionenabled", + "type": "boolean" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "true if instance lease feature is enabled", + "name": "instanceleaseenabled", + "type": "boolean" + }, + { + "description": "true if region wide secondary is enabled, false otherwise", + "name": "regionsecondaryenabled", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "If invitation confirmation is required when add account to project", + "name": "projectinviterequired", + "type": "boolean" + }, + { + "description": "the min CPU count for the service offering used by the shared filesystem instance", + "name": "sharedfsvmmincpucount", "type": "integer" - } - ] - }, - { - "description": "Cleanups VM reservations in the database.", - "isasync": true, - "name": "cleanVMReservations", - "params": [], - "response": [ + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if regular user is allowed to create projects", + "name": "allowusercreateprojects", + "type": "boolean" }, - {}, - {}, { "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", + "description": "true if the user can recover and expunge virtualmachines, false otherwise", + "name": "allowuserexpungerecovervm", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if dynamically scaling for instances is enabled", + "name": "dynamicscalingenabled", + "type": "boolean" + }, + { + "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", + "name": "kubernetesclusterexperimentalfeaturesenabled", + "type": "boolean" + }, + { + "description": "the retention time for Instances disks stats", + "name": "instancesdisksstatsretentiontime", + "type": "integer" + }, + { + "description": "true if stats are collected only for user instances, false if system instance stats are also collected", + "name": "instancesstatsuseronly", + "type": "boolean" } ] }, { - "description": " delete a Brocade VCS Switch", + "description": "Release dedication of zone", "isasync": true, - "name": "deleteBrocadeVcsDevice", + "name": "releaseDedicatedZone", "params": [ { - "description": "Brocade Switch ID", + "description": "the ID of the Zone", "length": 255, - "name": "vcsdeviceid", - "related": "addBrocadeVcsDevice,listBrocadeVcsDevices", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "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": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, { - "description": "Extracts an ISO", + "description": "Updates a network serviceProvider of a physical network", "isasync": true, - "name": "extractIso", + "name": "updateNetworkServiceProvider", "params": [ { - "description": "the ID of the zone where the ISO is originally located", + "description": "the list of services to be enabled for this physical network service provider", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "servicelist", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the ID of the ISO file", + "description": "Enabled/Disabled/Shutdown the physical network service provider", "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - }, - { - "description": "the URL to which the ISO would be extracted", - "length": 2048, - "name": "url", + "name": "state", "required": false, "type": "string" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "network service provider id", "length": 255, - "name": "mode", + "name": "id", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", "required": true, - "type": "string" + "type": "uuid" } ], - "related": "downloadImageStoreObject,extractTemplate,extractVolume", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "response": [ { - "description": "the id of extracted object", - "name": "id", - "type": "string" - }, - { - "description": "the name of the extracted object", - "name": "name", - "type": "string" - }, - { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", - "type": "string" - }, - {}, - { - "description": "zone ID the object was extracted from", - "name": "zoneid", - "type": "string" - }, - { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, - { - "description": "the account id to which the extracted object belongs", - "name": "accountid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, {}, { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" - }, - { - "description": "zone name the object was extracted from", - "name": "zonename", - "type": "string" - }, - { - "description": "the mode of extraction - upload or download", - "name": "extractMode", - "type": "string" - }, - { - "description": "the status of the extraction", - "name": "status", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -19944,577 +18229,524 @@ var preCache = `{ "type": "integer" }, { - "description": "", - "name": "resultstring", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "uuid of the network provider", + "name": "id", "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" } - ] + ], + "since": "3.0.0" }, { - "description": "Lists object storage pools.", - "isasync": false, - "name": "listObjectStoragePools", + "description": "Check the volume for any errors or leaks and also repairs when repair parameter is passed, this is currently supported for KVM only", + "isasync": true, + "name": "checkVolume", "params": [ { - "description": "the object store provider", - "length": 255, - "name": "provider", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the storage pool", + "description": "The ID of the volume", "length": 255, "name": "id", - "related": "addObjectStoragePool,listObjectStoragePools", - "required": false, + "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, "type": "uuid" }, { - "description": "the name of the object store", + "description": "parameter to repair the volume, leaks or all are the possible values", "length": 255, - "name": "name", + "name": "repair", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], - "related": "addObjectStoragePool", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the total size of the object store", - "name": "storagetotal", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the provider name of the object store", - "name": "providername", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the url of the object store", - "name": "url", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, - {}, { - "description": "the ID of the object store", - "name": "id", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the object store", + "description": "name of the disk volume", "name": "name", "type": "string" }, { - "description": "the object store currently used size", - "name": "storageused", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } - ], - "since": "4.19.0" - }, - { - "description": "create secondary staging store.", - "isasync": false, - "name": "createSecondaryStagingStore", - "params": [ + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, { - "description": "the URL for the staging store", - "length": 2048, - "name": "url", - "required": true, + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the staging store provider name", - "length": 255, - "name": "provider", - "required": false, + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the scope of the staging store: zone only for now", - "length": 255, - "name": "scope", - "required": false, + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the Zone ID for the staging store", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "the details for the staging store", - "length": 255, - "name": "details", - "required": false, + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", "type": "map" - } - ], - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "response": [ - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the ID of the image store", + "description": "ID of the disk volume", "name": "id", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Creates an affinity/anti-affinity group", - "isasync": true, - "name": "createAffinityGroup", - "params": [ - { - "description": "domainId of the account owning the affinity group", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" }, { - "description": "create affinity group for project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "optional description of the affinity group", - "length": 255, - "name": "description", - "required": false, - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "Type of the affinity group from the available affinity/anti-affinity group types", - "length": 255, - "name": "type", - "required": true, + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "name of the affinity group", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "an account for the affinity group. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the description of the affinity group", - "name": "description", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "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 account owning the affinity group", - "name": "account", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {} - ] - }, - { - "description": "Remove a VMware datacenter from a zone.", - "isasync": false, - "name": "removeVmwareDc", - "params": [ - { - "description": "The id of Zone from which VMware datacenter has to be removed.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Logs a user into the CloudStack after successful verification of OAuth secret code from the particular provider.A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the \"logout\" command has been issued or the session has expired.", - "isasync": false, - "name": "oauthlogin", - "params": [ + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, { - "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", - "length": 255, - "name": "secretcode", - "required": false, + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", - "length": 255, - "name": "domain", - "required": false, + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "Name of the provider", - "length": 255, - "name": "provider", - "required": true, + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", - "length": 255, - "name": "domainId", - "required": false, + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "Email id with which user tried to login using OAuth provider", - "length": 255, - "name": "email", - "required": true, + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" - } - ], - "related": "login", - "response": [ - { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" }, { - "description": "Is two factor authentication verified", - "name": "is2faverified", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "last name of the user", - "name": "lastname", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "Is user registered", - "name": "registered", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "Domain ID that the user belongs to", - "name": "domainid", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, - {}, { - "description": "the account name the user belongs to", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "Username", - "name": "username", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "first name of the user", - "name": "firstname", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", - "type": "string" - }, - { - "description": "user time zoneoffset", - "name": "timezoneoffset", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, - {}, { - "description": "user time zone", - "name": "timezone", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "User ID", - "name": "userid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" } ], - "since": "4.19.0" + "since": "4.19.1" }, { - "description": "Lists all available Internal Load Balancer elements.", + "description": "Lists Management Server metrics", "isasync": false, - "name": "listInternalLoadBalancerElements", + "name": "listManagementServersMetrics", "params": [ { - "description": "list internal load balancer elements by network service provider id", + "description": "the name of the management server", "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list internal load balancer elements by enabled state", + "description": "include system level stats", "length": 255, - "name": "enabled", + "name": "system", + "related": "listManagementServersMetrics", "required": false, "type": "boolean" }, { - "description": "", + "description": "the id of the management server", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listManagementServers", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "Whether to return the management server peers or not. By default, the management server peers will not be returned.", "length": 255, - "name": "keyword", + "name": "peers", "required": false, - "type": "string" + "since": "4.20.1.0", + "type": "boolean" }, { "description": "", @@ -20524,308 +18756,289 @@ var preCache = `{ "type": "integer" }, { - "description": "list internal load balancer elements by id", + "description": "", "length": 255, - "name": "id", - "related": "createInternalLoadBalancerElement,configureInternalLoadBalancerElement,listInternalLoadBalancerElements", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], - "related": "createInternalLoadBalancerElement,configureInternalLoadBalancerElement", + "related": "", "response": [ { - "description": "the id of the internal load balancer element", - "name": "id", - "type": "string" + "description": "The number of terminated threads", + "name": "threadsteminatedcount", + "type": "integer" }, - {}, { - "description": "the physical network service provider id of the element", - "name": "nspid", + "description": "Amount of memory used", + "name": "systemmemoryused", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of memory used by this Management Server", + "name": "heapmemoryused", + "type": "long" }, { - "description": "Enabled/Disabled the element", - "name": "enabled", + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" + }, + { + "description": "the number of pending jobs in this Management Server", + "name": "pendingjobscount", + "type": "long" + }, + { + "description": "the system is running against a local database", + "name": "dbislocal", "type": "boolean" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Updates load balancer health check policy", - "isasync": true, - "name": "updateLBHealthCheckPolicy", - "params": [ + }, { - "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": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" }, { - "description": "ID of load balancer health check policy", - "length": 255, - "name": "id", - "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies,updateLBHealthCheckPolicy", - "required": true, - "type": "uuid" + "description": "the last agents this Management Server is responsible for, before shutdown or preparing for maintenance", + "name": "lastagents", + "type": "list" }, { - "description": "an optional field, whether to the display the policy to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "the system load for user, and system processes and the system idle cycles", + "name": "systemcycleusage", + "type": "long[]" + }, + { + "description": "the number of host agents this Management Server is responsible for", + "name": "agentscount", + "type": "long" + }, + { + "description": "The number of waiting threads", + "name": "threadswaitingcount", + "type": "integer" + }, + { + "description": "the system has a usage server running locally", + "name": "usageislocal", "type": "boolean" - } - ], - "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", - "response": [ + }, + { + "description": "the load averages for 1 5 and 15 minutes", + "name": "systemloadaverages", + "type": "double[]" + }, + { + "description": "the java distribution name running the management server process", + "name": "javadistribution", + "type": "string" + }, + { + "description": "the IP Address for this Management Server", + "name": "ipaddress", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Free system memory", + "name": "systemmemoryfree", "type": "string" }, {}, { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", "type": "string" }, { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "type": "string" + "description": "The number of runnable threads", + "name": "threadsrunnablecount", + "type": "integer" }, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "the name of the management server", + "name": "name", "type": "string" }, { - "description": "the list of healthcheckpolicies", - "name": "healthcheckpolicy", - "response": [ - { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" - }, - { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "type": "string" - }, - { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" - }, - { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" - }, - { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" - }, - { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - } - ], + "description": "the Management Server Peers", + "name": "peers", "type": "list" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "Total system memory", + "name": "systemmemorytotal", "type": "string" }, - {}, { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "the amount of memory allocated to this Management Server", + "name": "heapmemorytotal", + "type": "long" + }, + { + "description": "the number of client sessions active on this Management Server", + "name": "sessions", + "type": "long" + }, + { + "description": "Virtual size of the fully loaded process", + "name": "systemmemoryvirtualsize", "type": "string" - } - ], - "since": "4.4" - }, - { - "description": "Gets the guest OS names in the hypervisor", - "isasync": true, - "name": "getHypervisorGuestOsNames", - "params": [ + }, { - "description": "Hypervisor version to get the guest os names (atleast one hypervisor host with the version specified must be available)", - "length": 255, - "name": "hypervisorversion", - "required": true, + "description": "the total system cpu capacity", + "name": "systemtotalcpucycles", + "type": "double" + }, + { + "description": "the version of the management server", + "name": "version", "type": "string" }, { - "description": "Keyword for guest os name", - "length": 255, - "name": "keyword", - "required": false, + "description": "the number of agents this Management Server is responsible for", + "name": "agentcount", + "type": "integer" + }, + { + "description": "the agents this Management Server is responsible for", + "name": "agents", + "type": "list" + }, + { + "description": "The number of blocked threads", + "name": "threadsblockedcount", + "type": "integer" + }, + { + "description": "the ID of the management server", + "name": "id", "type": "string" }, { - "description": "Hypervisor type. One of : VMware, XenServer", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" + }, + { + "description": "the log files and their usage on disk", + "name": "loginfo", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "version of the hypervisor for guest os names", - "name": "hypervisorversion", + "description": "The number of threads", + "name": "threadstotalcount", + "type": "integer" + }, + { + "description": "the version of the java distribution running the management server process", + "name": "javaversion", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "The number of daemon threads", + "name": "threadsdaemoncount", "type": "integer" }, { - "description": "the guest OS list of the hypervisor", - "name": "guestoslist", - "response": [ - { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", - "type": "string" - }, - { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", - "type": "string" - } - ], - "type": "list" + "description": "the current cpu load", + "name": "cpuload", + "type": "string" + }, + { + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" + }, + { + "description": "the number of processors available to the JVM", + "name": "availableprocessors", + "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", + "name": "serviceip", "type": "string" }, { - "description": "the guest OS count of the hypervisor", - "name": "guestoscount", - "type": "integer" + "description": "the state of the management server", + "name": "state", + "type": "state" } ], - "since": "4.19.0" + "since": "4.17.0" }, { - "description": "remove Tungsten-Fabric policy", + "description": "Removes a virtual machine or a list of virtual machines from a load balancer rule.", "isasync": true, - "name": "removeTungstenFabricPolicyRule", + "name": "removeFromLoadBalancerRule", "params": [ { - "description": "the Uuid of Tungsten-Fabric policy", + "description": "The ID of the load balancer rule", "length": 255, - "name": "policyuuid", + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the ID of zone", + "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "vmidipmap", + "required": false, + "since": "4.4", + "type": "map" }, { - "description": "the Uuid of Tungsten-Fabric policy rule", + "description": "the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)", "length": 255, - "name": "ruleuuid", - "required": true, - "type": "string" + "name": "virtualmachineids", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": false, + "type": "list" } ], - "related": "listTungstenFabricPolicy,applyTungstenFabricPolicy,removeTungstenFabricPolicy", "response": [ { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Tungsten-Fabric policy name", - "name": "name", - "type": "string" - }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -20835,1118 +19048,886 @@ var preCache = `{ ] }, { - "description": "Create Tungsten-Fabric provider in cloudstack", + "description": "Lists vm groups", "isasync": false, - "name": "createTungstenFabricProvider", + "name": "listInstanceGroups", "params": [ { - "description": "Tungsten-Fabric provider introspect port", + "description": "List by keyword", "length": 255, - "name": "tungstenproviderintrospectport", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Tungsten-Fabric provider name", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "Tungsten-Fabric provider hostname", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "tungstenproviderhostname", - "required": true, - "type": "string" + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "Tungsten-Fabric provider gateway", + "description": "", "length": 255, - "name": "tungstengateway", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Tungsten-Fabric provider port", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "tungstenproviderport", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "list instance groups by name", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list instance groups by ID", + "length": 255, + "name": "id", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "required": false, "type": "uuid" }, { - "description": "Tungsten-Fabric provider vrouter port", + "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": "tungstenprovidervrouterport", + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" } ], - "related": "listTungstenFabricProviders", + "related": "createInstanceGroup,updateInstanceGroup", "response": [ { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the project ID of the instance group", + "name": "projectid", + "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, { - "description": "Tungsten-Fabric provider hostname", - "name": "tungstenproviderhostname", + "description": "the ID of the instance group", + "name": "id", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, {}, + { + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric provider name", + "description": "the account owning the instance group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the instance group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the instance group", "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", + "description": "time and date the instance group was created", + "name": "created", + "type": "date" + }, + { + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider port", - "name": "tungstenproviderport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Creates a static route", + "isasync": true, + "name": "createStaticRoute", + "params": [ + { + "description": "static route cidr", + "length": 255, + "name": "cidr", + "required": true, "type": "string" }, { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", + "description": "the gateway id we are creating static route for. Mutually exclusive with the nexthop parameter", + "length": 255, + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "required": false, + "type": "uuid" + }, + { + "description": "the vpc id for which the static route is created. This is required for nexthop parameter", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "the next hop of static route. Mutually exclusive with the gatewayid parameter", + "length": 255, + "name": "nexthop", + "required": false, + "since": "4.21.0", + "type": "string" + } + ], + "related": "listStaticRoutes", + "response": [ + { + "description": "the project name of the static route", + "name": "project", "type": "string" }, { - "description": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", + "description": "the ID of the domain associated with the static route", + "name": "domainid", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "VPC the static route belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "Tungsten-Fabric provider vrouter port", - "name": "tungstenprovidervrouterport", + "description": "the account associated with the static route", + "name": "account", + "type": "string" + }, + { + "description": "the ID of static route", + "name": "id", + "type": "string" + }, + { + "description": "the domain path associated with the static route", + "name": "domainpath", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the project id of the static route", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "VPC gateway the route is created for", + "name": "vpcgatewayid", + "type": "string" + }, + { + "description": "the list of resource tags associated with static route", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the state of the static route", + "name": "state", + "type": "string" + }, + { + "description": "the domain associated with the static route", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "static route CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "Next hop of the static route", + "name": "nexthop", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "IP of VPC gateway the route is created for", + "name": "vpcgatewayip", + "type": "string" } ] }, { - "description": "Enables HA cluster-wide", + "description": "Deletes a Private gateway", "isasync": true, - "name": "enableHAForCluster", + "name": "deletePrivateGateway", "params": [ { - "description": "ID of the cluster", + "description": "the ID of the private gateway", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "id", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "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": "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.11" + ] }, { - "description": "Reboots a virtual machine.", - "isasync": true, - "name": "rebootVirtualMachine", + "description": "Updates a domain with a new name", + "isasync": false, + "name": "updateDomain", "params": [ { - "description": "Force reboot the VM (VM is Stopped and then Started)", + "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", "length": 255, - "name": "forced", + "name": "networkdomain", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "string" }, { - "description": "Boot into hardware setup menu or not", + "description": "updates domain with this name", "length": 255, - "name": "bootintosetup", + "name": "name", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "type": "string" }, { - "description": "The ID of the virtual machine", + "description": "ID of domain to update", "length": 255, "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": true, "type": "uuid" } ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "response": [ { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the state of the domain", + "name": "state", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" + }, + { + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total number of gpus owned by domain", + "name": "gputotal", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + {}, + { + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", + "type": "string" + }, + { + "description": "the total number of backups available to this domain", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the path of the domain", + "name": "path", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "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 domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" + }, + {}, + { + "description": "the total number of gpus the domain can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "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 name of the affinity group", - "name": "project", - "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 domain name of the affinity group", - "name": "domain", - "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": "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 type of the affinity group", - "name": "type", - "type": "string" - } - ], - "type": "set" + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "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" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of the domain", + "name": "name", "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", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - } - ], - "type": "set" + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "whether the domain has one or more sub-domains", + "name": "haschild", "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + } + ] + }, + { + "description": "Disables an AutoScale Vm Group", + "isasync": true, + "name": "disableAutoScaleVmGroup", + "params": [ + { + "description": "the ID of the autoscale group", + "length": 255, + "name": "id", + "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "required": true, + "type": "uuid" + } + ], + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "response": [ + { + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the private port", + "name": "privateport", "type": "string" }, {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the public ip address", + "name": "publicip", "type": "string" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, + {}, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { "description": "the UUID of the latest async job acting on this object", @@ -21954,152 +19935,246 @@ var preCache = `{ "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the project id of the vm group", + "name": "projectid", + "type": "string" + } + ] + }, + { + "description": "Creates a snapshot policy for the account.", + "isasync": false, + "name": "createSnapshotPolicy", + "params": [ + { + "description": "the ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, - {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "an optional field, whether to the display the policy to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "length": 255, + "name": "timezone", + "required": true, "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", + "length": 255, + "name": "storageids", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.21.0", + "type": "list" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "A list of IDs of the zones in which the snapshots will be made available.The snapshots will always be made available in the zone in which the volume is present.", + "length": 255, + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "list" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)", + "length": 255, + "name": "schedule", + "required": true, "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "maximum number of snapshots to retain", + "length": 255, + "name": "maxsnaps", + "required": true, + "type": "integer" + }, + { + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "length": 255, + "name": "intervaltype", + "required": true, "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "This parameter enables the option the snapshot to be copied to supported primary storage", + "length": 255, + "name": "usestoragereplication", + "required": false, + "since": "4.21.0", + "type": "boolean" + } + ], + "related": "updateSnapshotPolicy,listSnapshotPolicies", + "response": [ + { + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "The list of pools in which snapshot backup is scheduled", + "name": "storage", + "type": "set" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, + {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the ID of the snapshot policy", + "name": "id", + "type": "string" } ] }, { - "description": "Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", - "isasync": false, - "name": "addVirtualMachinesToKubernetesCluster", + "description": "Disables HA for a zone", + "isasync": true, + "name": "disableHAForZone", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "ID of the zone", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" - }, - { - "description": "Is control node or not? Defaults to false.", - "length": 255, - "name": "iscontrolnode", - "required": false, - "type": "boolean" - }, - { - "description": "the IDs of the VMs to add to the cluster", - "length": 255, - "name": "virtualmachineids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "list" } ], "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" }, {}, { @@ -22108,337 +20183,193 @@ var preCache = `{ "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ], - "since": "4.19.0" + "since": "4.11" }, { - "description": "Creates a load balancer rule", + "description": "Unmanage a volume on storage pool.", "isasync": true, - "name": "createLoadBalancerRule", + "name": "unmanageVolume", "params": [ { - "description": "the domain ID associated with the load balancer", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, - { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "The ID of the volume to unmanage", "length": 255, - "name": "algorithm", - "required": true, - "type": "string" - }, - { - "description": "the public port from where the network traffic will be load balanced from", - "length": 255, - "name": "publicport", + "name": "id", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": true, - "type": "integer" - }, - { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true", - "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed.", - "length": 255, - "name": "cidrlist", - "required": false, - "since": "4.18.0.0", - "type": "list" - }, - { - "description": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, "type": "uuid" - }, + } + ], + "response": [ + {}, { - "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", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", - "length": 255, - "name": "protocol", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public IP address ID from where the network traffic will be load balanced from", - "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ], + "since": "4.19.1" + }, + { + "description": "Adds an API permission to a role", + "isasync": false, + "name": "createRolePermission", + "params": [ { - "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", + "description": "The API name or wildcard rule such as list*", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "name": "rule", + "required": true, + "type": "string" }, { - "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", + "description": "ID of the role", "length": 255, - "name": "privateport", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "the account associated with the load balancer. Must be used with the domainId parameter.", + "description": "The rule permission, allow or deny. Default: deny.", "length": 255, - "name": "account", - "required": false, + "name": "permission", + "required": true, "type": "string" }, { - "description": "name of the load balancer rule", + "description": "The description of the role permission", "length": 255, - "name": "name", - "required": true, + "name": "description", + "required": false, "type": "string" } ], - "related": "listLoadBalancerRules,updateLoadBalancerRule", + "related": "listRolePermissions", "response": [ { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", "type": "string" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, {}, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", + "description": "the ID of the role permission", + "name": "id", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the list of resource tags associated with load balancer", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "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 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the description of the role permission", + "name": "description", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" } - ] + ], + "since": "4.9.0" }, { - "description": "list Tungsten-Fabric logical router", + "description": "List system virtual machines.", "isasync": false, - "name": "listTungstenFabricLogicalRouter", + "name": "listSystemVms", "params": [ { - "description": "", + "description": "the host ID of the system VM", "length": 255, - "name": "pagesize", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of zone", + "description": "the ID of the system VM", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric logical router", + "description": "CPU arch of the system VM", "length": 255, - "name": "logicalrouteruuid", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" }, { - "description": "the uuid of Tungsten-Fabric network", + "description": "the name of the system VM", "length": 255, - "name": "networkuuid", + "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "page", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "integer" + "since": "3.0.1", + "type": "uuid" + }, + { + "description": "the Zone ID of the system VM", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { "description": "List by keyword", @@ -22446,562 +20377,318 @@ var preCache = `{ "name": "keyword", "required": false, "type": "string" - } - ], - "related": "createTungstenFabricLogicalRouter,addTungstenFabricNetworkGatewayToLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", - "response": [ - {}, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", - "type": "string" + "description": "the Pod ID of the system VM", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", + "length": 255, + "name": "systemvmtype", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Tungsten-Fabric logical router name", - "name": "name", + "description": "the state of the system VM", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - } - ] - }, - { - "description": "Import vSphere storage policies", - "isasync": false, - "name": "importVsphereStoragePolicies", - "params": [ - { - "description": "ID of the zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], - "related": "listVsphereStoragePolicies", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the second DNS for the system VM", + "name": "dns2", "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 Policy", - "name": "id", - "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 description of the Storage Policy", - "name": "description", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, - {}, - {}, { - "description": "the name of the Storage Policy", - "name": "name", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", - "type": "string" - } - ] - }, - { - "description": "Adds a guest OS name to hypervisor OS name mapping", - "isasync": true, - "name": "addGuestOsMapping", - "params": [ - { - "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", - "length": 255, - "name": "hypervisorversion", - "required": true, + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", - "length": 255, - "name": "osmappingcheckenabled", - "required": false, - "since": "4.19.0", - "type": "boolean" - }, - { - "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", - "length": 255, - "name": "osdisplayname", - "required": false, + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "OS name specific to the hypervisor", - "length": 255, - "name": "osnameforhypervisor", - "required": true, + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", - "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" - }, - { - "description": "Forces add user defined guest os mapping, overrides any existing user defined mapping", - "length": 255, - "name": "forced", - "required": false, - "since": "4.19.0", - "type": "boolean" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "Hypervisor type. One of : XenServer, KVM, VMWare", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" - } - ], - "related": "updateGuestOsMapping", - "response": [ + }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "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": "the ID of the Guest OS mapping", + "description": "the ID of the system VM", "name": "id", "type": "string" }, - {}, - { - "description": "the hypervisor", - "name": "hypervisor", - "type": "string" - }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", - "type": "string" - } - ], - "since": "4.4.0" - }, - { - "description": "Disables out-of-band management for a zone", - "isasync": true, - "name": "disableOutOfBandManagementForZone", - "params": [ - { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", - "response": [ - { - "description": "the ID of the host", - "name": "hostid", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, + {}, { - "description": "the operation result description", - "name": "description", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, - {}, - {} - ], - "since": "4.9.0" - }, - { - "description": "List all public, private, and privileged VNF templates.", - "isasync": false, - "name": "listVnfTemplates", - "params": [ { - "description": "the hypervisor for which to restrict the search", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", - "length": 255, - "name": "details", - "required": false, - "since": "4.15", - "type": "list" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "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 true, list only unique templates across zones", - "length": 255, - "name": "showunique", - "required": false, - "since": "4.13.2", - "type": "boolean" + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the IDs of the templates, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "since": "4.9", - "type": "list" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "flag to display the resource image for the templates", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "description": "the host ID for the system VM", + "name": "hostid", + "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": "the hostname for the system VM", + "name": "hostname", + "type": "string" }, { - "description": "the type of the template", - "length": 255, - "name": "templatetype", - "required": false, - "since": "4.19.0", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "list templates by zoneId", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", - "length": 255, - "name": "templatefilter", - "required": true, + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "list datadisk templates by parent template id", - "length": 255, - "name": "parenttemplateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "since": "4.4", - "type": "uuid" - }, - { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", - "length": 255, - "name": "isvnf", - "required": false, - "since": "4.19.0", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the template name", - "length": 255, - "name": "name", - "required": false, + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "show removed templates as well", - "length": 255, - "name": "showremoved", - "required": false, - "type": "boolean" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", "type": "integer" - }, + } + ] + }, + { + "description": "Detaches a disk volume from a virtual machine.", + "isasync": true, + "name": "detachVolume", + "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the device ID on the virtual machine where volume is detached from", "length": 255, - "name": "account", + "name": "deviceid", "required": false, - "type": "string" + "type": "long" }, { - "description": "the template ID", + "description": "the ID of the disk volume", "length": 255, "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the ID of the virtual machine where the volume is detached from", "length": 255, - "name": "listall", + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": false, - "type": "boolean" + "type": "uuid" } ], - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the size of the template", - "name": "size", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, - {}, - { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "checksum of the template", - "name": "checksum", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, { - "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 ID of the domain to which the template belongs", + "description": "the ID of the domain associated with the disk volume", "name": "domainid", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -23010,8 +20697,13 @@ var preCache = `{ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -23024,751 +20716,1037 @@ var preCache = `{ "name": "resourceid", "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": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, - {}, { - "description": "true if the template is extractable, false otherwise", + "description": "true if the volume is extractable, false otherwise", "name": "isextractable", "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the project name of the template", - "name": "project", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "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", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "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 secondary storage host for the template", - "name": "hostname", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + {}, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" } - ], - "since": "4.19.0" + ] }, { - "description": "Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.", + "description": "Replaces ACL associated with a network or private gateway", "isasync": true, - "name": "deployVnfAppliance", + "name": "replaceNetworkACLList", "params": [ { - "description": "Enable packed virtqueues or not.", + "description": "the ID of the private gateway", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "required": false, - "since": "4.18", - "type": "boolean" + "type": "uuid" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "description": "the ID of the network ACL", "length": 255, - "name": "size", - "required": false, - "type": "long" + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", + "required": true, + "type": "uuid" }, { - "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", + "description": "the ID of the network", "length": 255, - "name": "iothreadsenabled", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", - "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup,updateSecurityGroup", - "required": false, - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Deploy vm for the project", + "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 Tungsten-Fabric address group", + "isasync": false, + "name": "listTungstenFabricAddressGroup", + "params": [ + { + "description": "the ID of zone", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "List by keyword", "length": 255, - "name": "customid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "an optional user generated name for the virtual machine", + "description": "", "length": 255, - "name": "displayname", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Controls specific policies on IO", + "description": "the uuid of Tungsten-Fabric address group", "length": 255, - "name": "iodriverpolicy", + "name": "addressgroupuuid", "required": false, "type": "string" }, { - "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", + "description": "", "length": 255, - "name": "iptonetworklist", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" + } + ], + "related": "createTungstenFabricAddressGroup", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the ipv6 address for default vm's network", - "length": 255, - "name": "ip6address", - "required": false, + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", + "type": "int" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", - "length": 255, - "name": "bootmode", - "required": false, - "since": "4.14.0.0", + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", "type": "string" }, { - "description": "an optional group for the virtual machine", - "length": 255, - "name": "group", - "required": false, + "description": "Tungsten-Fabric address group name", + "name": "name", "type": "string" }, { - "description": "the ID of the template for the virtual machine", + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", + "type": "string" + }, + {} + ] + }, + { + "description": "Enables out-of-band management for a zone", + "isasync": true, + "name": "enableOutOfBandManagementForZone", + "params": [ + { + "description": "the ID of the zone", "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" - }, + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", + "response": [ { - "description": "name of the ssh key pair used to login to the virtual machine", - "length": 255, - "name": "keypair", - "required": false, + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable", - "length": 255, - "name": "dynamicscalingenabled", - "required": false, - "since": "4.16", + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", "type": "boolean" }, { - "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", - "length": 255, - "name": "nicnetworklist", - "required": false, - "since": "4.15", - "type": "map" + "description": "the operation result description", + "name": "description", + "type": "string" }, { - "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", - "length": 255, - "name": "datadiskofferinglist", - "required": false, - "since": "4.11", - "type": "map" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.", - "length": 1048576, - "name": "userdata", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the ip address for default vm's network", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "used to specify the vApp properties.", - "length": 255, - "name": "properties", - "required": false, - "since": "4.15", - "type": "map" + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" }, { - "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + {}, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the operation result", + "name": "status", + "type": "boolean" + } + ], + "since": "4.9.0" + }, + { + "description": "Lists LDAP Users according to the specifications from the user request.", + "isasync": false, + "name": "listLdapUsers", + "params": [ + { + "description": "Determines what type of filter is applied on the list of users returned from LDAP.\n\tvalid values are\n\t'NoFilter'\t no filtering is done,\n\t'LocalDomain'\tusers already in the current or requested domain will be filtered out of the result list,\n\t'AnyDomain'\tusers that already exist anywhere in cloudstack will be filtered out, and\n\t'PotentialImport'\tall users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource", "length": 255, - "name": "keyboard", + "name": "userfilter", "required": false, + "since": "4.13", "type": "string" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "linked domain", "length": 255, - "name": "startvm", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", + "description": "List by keyword", "length": 255, - "name": "hypervisor", + "name": "keyword", "required": false, "type": "string" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter", "length": 255, - "name": "details", + "name": "listtype", "required": false, - "since": "4.3", - "type": "map" + "type": "string" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "", "length": 255, - "name": "keypairs", + "name": "pagesize", "required": false, - "since": "4.17", - "type": "list" + "type": "integer" }, { - "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "description": "", "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup,updateSecurityGroup", + "name": "page", "required": false, - "type": "list" + "type": "integer" + } + ], + "related": "searchLdap,importLdapUsers", + "response": [ + { + "description": "The user's email", + "name": "email", + "type": "string" }, { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", - "length": 255, - "name": "password", - "required": false, - "since": "4.19.0.0", + "description": "The user's firstname", + "name": "firstname", "type": "string" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", - "length": 255, - "name": "copyimagetags", - "required": false, - "since": "4.13", - "type": "boolean" + "description": "The user's lastname", + "name": "lastname", + "type": "string" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "description": "The user's domain", + "name": "domain", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The user's principle", + "name": "principal", + "type": "string" + }, + { + "description": "The user's username", + "name": "username", + "type": "string" + }, + {} + ], + "since": "4.2.0" + }, + { + "description": "Create VM Schedule", + "isasync": false, + "name": "createVMSchedule", + "params": [ + { + "description": "Description of the schedule", "length": 255, - "name": "affinitygroupnames", - "related": "", + "name": "description", "required": false, - "type": "list" + "type": "string" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "description": "Action to take on the VM (start/stop/reboot/force_stop/force_reboot).", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "name": "action", + "required": true, + "type": "string" }, { - "description": "The number of queues for multiqueue NICs.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "length": 255, - "name": "nicmultiqueuenumber", - "required": false, - "since": "4.18", - "type": "integer" + "name": "timezone", + "required": true, + "type": "string" }, { - "description": "host name for the virtual machine", + "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", "length": 255, - "name": "name", - "required": false, + "name": "schedule", + "required": true, "type": "string" }, { - "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "boottype", + "name": "enddate", "required": false, - "since": "4.14.0.0", - "type": "string" + "type": "date" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "Enable VM schedule. Defaults to true", "length": 255, - "name": "displayvm", + "name": "enabled", "required": false, - "since": "4.2", "type": "boolean" }, { - "description": "the ID of the Userdata", + "description": "start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "userdataid", - "related": "", + "name": "startdate", "required": false, - "since": "4.18", - "type": "uuid" + "type": "date" }, { - "description": "the mac address for default vm's network", + "description": "ID of the VM for which schedule is to be defined", "length": 255, - "name": "macaddress", - "required": false, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "updateVMSchedule", + "response": [ + { + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", - "required": false, - "since": "4.12", + "description": "Cron formatted VM schedule", + "name": "schedule", "type": "string" }, { - "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": false, - "type": "uuid" + "description": "Description of VM schedule", + "name": "description", + "type": "string" }, { - "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", - "length": 255, - "name": "rootdisksize", - "required": false, - "since": "4.4", - "type": "long" + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", - "length": 255, - "name": "dhcpoptionsnetworklist", - "required": false, - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "description": "ID of virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Action", + "name": "action", + "type": "action" + }, + {}, + { + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" + }, + {}, + { + "description": "the ID of VM schedule", + "name": "id", + "type": "string" + }, + { + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" + } + ], + "since": "4.19.0" + }, + { + "description": "List the IP forwarding rules", + "isasync": false, + "name": "listIpForwardingRules", + "params": [ + { + "description": "", "length": 255, - "name": "networkids", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "page", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", + "description": "list the rule belonging to this public IP address", "length": 255, - "name": "overridediskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "since": "4.17", "type": "uuid" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "List by keyword", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "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": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "availability zone for the virtual machine", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "required": false, "type": "uuid" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "Lists all rules applied to the specified VM.", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": false, "type": "uuid" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "deploymentplanner", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "isrecursive", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "vnfcidrlist", + "name": "account", "required": false, - "type": "list" + "type": "string" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "bootintosetup", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "type": "uuid" }, { - "description": "True by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. False otherwise. Network rules are configured if management network is an isolated network or shared network with security groups.", + "description": "", "length": 255, - "name": "vnfconfiguremanagement", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" } ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", "response": [ { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "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", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, + {}, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -23777,1325 +21755,678 @@ var preCache = `{ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "set" + "type": "list" }, + {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, - {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" + } + ] + }, + { + "description": "Creates an instant snapshot of a volume.", + "isasync": true, + "name": "createSnapshot", + "params": [ + { + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", + "length": 255, + "name": "storageids", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.21.0", + "type": "list" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", + "length": 255, + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.19.0", + "type": "list" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "quiesce vm if true", + "length": 255, + "name": "quiescevm", + "required": false, + "type": "boolean" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "asynchronous backup if true", + "length": 255, + "name": "asyncbackup", + "required": false, "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the name of the snapshot", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "The ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", + "length": 255, + "name": "policyid", + "related": "updateSnapshotPolicy,listSnapshotPolicies", + "required": false, + "type": "uuid" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", + "length": 255, + "name": "locationtype", + "required": false, "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "This parameter enables the option the snapshot to be copied to supported primary storage", + "length": 255, + "name": "usestoragereplication", + "required": false, + "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, + } + ], + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", + "response": [ { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "id of the os on volume", + "name": "ostypeid", "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 date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "name of the snapshot", + "name": "name", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "name of the disk volume", + "name": "volumename", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", + "type": "long" }, + {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the project id of the vm", - "name": "projectid", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "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 ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, - {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, + {}, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "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 project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the type of the affinity group", - "name": "type", - "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" - } - ], - "type": "set" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "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" - } - ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "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": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account owning the security group", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "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": "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the domain name of the security group", + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "tag key name", + "name": "key", + "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" } ], "type": "set" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, + } + ] + }, + { + "description": "Lists storage pool metrics", + "isasync": false, + "name": "listStoragePoolsMetrics", + "params": [ { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "If true, lists the custom stats of the storage pool", + "length": 255, + "name": "storagecustomstats", + "required": false, + "since": "4.18.1", + "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the IP address for the storage pool", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the storage access group", + "length": 255, + "name": "storageaccessgroup", + "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Updates a network offering.", - "isasync": false, - "name": "updateNetworkOffering", - "params": [ - { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 4096, - "name": "zoneid", + "description": "the status of the storage pool", + "length": 255, + "name": "status", "required": false, - "since": "4.13", "type": "string" }, { - "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "keepaliveenabled", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the availability of network offering. The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required ", + "description": "the scope of the storage pool", "length": 255, - "name": "availability", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" }, { - "description": "maximum number of concurrent connections supported by the network offering", + "description": "list storage pools belonging to the specific cluster", "length": 255, - "name": "maxconnections", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "update state for the network offering", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "state", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the display text of the network offering", + "description": "", "length": 255, - "name": "displaytext", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "sort key of the network offering, integer", + "description": "the ID of the storage pool", "length": 255, - "name": "sortkey", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", + "description": "the name of the storage pool", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "description": "", "length": 255, - "name": "domainid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the name of the network offering", + "description": "the storage pool path", "length": 255, - "name": "name", + "name": "path", "required": false, "type": "string" }, { - "description": "the id of the network offering", + "description": "host ID of the storage pools", "length": 255, - "name": "id", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" } ], - "related": "createNetworkOffering,listNetworkOfferings", + "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" - }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "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 storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", + "description": "whether this pool is managed or not", + "name": "managed", "type": "boolean" }, { - "description": "the id of the network offering", - "name": "id", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "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 traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the network offering", - "name": "name", + "description": "disk size in GiB", + "name": "disksizetotalgb", "type": "string" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" - }, - { - "description": "availability of the network offering", - "name": "availability", + "description": "disk size unallocated in GiB", + "name": "disksizeunallocatedgb", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "description": "the Zone ID of the storage pool", "name": "zoneid", "type": "string" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, + {}, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "disk size used in GiB", + "name": "disksizeusedgb", "type": "string" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "storage usage disable threshold exceeded", + "name": "storageusagedisablethreshold", "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, - { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" - }, - { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "type": "boolean" - } - ] - }, - { - "description": "Stops a system VM.", - "isasync": true, - "name": "stopSystemVm", - "params": [ - { - "description": "The ID of the system virtual machine", - "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", - "required": true, - "type": "uuid" - }, - { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - } - ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "response": [ - { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, - {}, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "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 total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, + {}, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "disk size allocated in GiB", + "name": "disksizeallocatedgb", "type": "string" }, { - "description": "the Zone name for the system VM", + "description": "the Zone name of the storage pool", "name": "zonename", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" + "description": "storage allocated notification threshold exceeded", + "name": "storageallocatedthreshold", + "type": "boolean" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "storage usage notification threshold exceeded", + "name": "storageusagethreshold", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -25103,306 +22434,446 @@ var preCache = `{ "type": "integer" }, { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" + "description": "storage allocated disable threshold exceeded", + "name": "storageallocateddisablethreshold", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" - }, + } + ], + "since": "4.9.3" + }, + { + "description": "Deletes a backup offering", + "isasync": false, + "name": "deleteBackupOffering", + "params": [ { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "ID of the backup offering", + "length": 255, + "name": "id", + "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.14.0" + }, + { + "description": "Create a new keypair and returns the private key", + "isasync": false, + "name": "createSSHKeyPair", + "params": [ + { + "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,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the state of the system VM", - "name": "state", + "description": "an optional account for the ssh key. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, "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" + } + ], + "related": "", + "response": [ { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the owner of the keypair", + "name": "account", + "type": "string" }, - {}, { - "description": "the name of the system VM", + "description": "Name of the keypair", "name": "name", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, + {}, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "Private key", + "name": "privatekey", "type": "string" - }, + } + ] + }, + { + "description": "list Tungsten-Fabric service group", + "isasync": false, + "name": "listTungstenFabricServiceGroup", + "params": [ { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the uuid of Tungsten-Fabric service group", + "length": 255, + "name": "servicegroupuuid", + "required": false, "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", - "type": "string" - } - ] - }, - { - "description": "Deletes an egress firewall rule", - "isasync": true, - "name": "deleteEgressFirewallRule", - "params": [ + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { - "description": "the ID of the firewall rule", + "description": "the ID of zone", "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", - "required": true, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, "type": "uuid" } ], + "related": "createTungstenFabricServiceGroup", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Tungsten-Fabric service group protocol", + "name": "protocol", + "type": "string" + }, + { + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "Tungsten-Fabric service group name", + "name": "name", + "type": "string" + }, + { + "description": "Tungsten-Fabric service group end port", + "name": "endport", + "type": "int" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" } ] }, { - "description": "Updates a VPC", + "description": "Authorizes a particular egress rule for this security group", "isasync": true, - "name": "updateVPC", + "name": "authorizeSecurityGroupEgress", "params": [ { - "description": "the name of the VPC", + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "name", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { - "description": "an optional field, whether to the display the vpc to the end user or not", + "description": "start port for this egress rule", "length": 255, - "name": "fordisplay", + "name": "startport", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "the id of the VPC", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", + "required": false, "type": "uuid" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC", + "description": "error code for this icmp message", "length": 255, - "name": "sourcenatipaddress", + "name": "icmpcode", "required": false, - "since": "4.19", - "type": "string" + "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "type of the icmp message being sent", "length": 255, - "name": "customid", + "name": "icmptype", + "required": false, + "type": "integer" + }, + { + "description": "end port for this egress rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "TCP is default. UDP is the other supported protocol", + "length": 255, + "name": "protocol", "required": false, - "since": "4.4", "type": "string" }, { - "description": "the display text of the VPC", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "displaytext", + "name": "account", "required": false, "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "publicmtu", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.18.0", - "type": "integer" + "type": "uuid" + }, + { + "description": "user to security group mapping", + "length": 255, + "name": "usersecuritygrouplist", + "required": false, + "type": "map" + }, + { + "description": "an optional project of the security group", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "length": 255, + "name": "securitygroupname", + "required": false, + "type": "string" } ], - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "related": "authorizeSecurityGroupIngress", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, + {}, { - "description": "the list of resource tags associated with the project", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -25411,8 +22882,8 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -25421,442 +22892,450 @@ var preCache = `{ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, + {}, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists storage pools.", + "isasync": false, + "name": "listStoragePools", + "params": [ + { + "description": "host ID of the storage pools", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "the name of the storage access group", + "length": 255, + "name": "storageaccessgroup", + "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "the Pod ID for the storage pool", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, - {}, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the scope of the storage pool", + "length": 255, + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "If true, lists the custom stats of the storage pool", + "length": 255, + "name": "storagecustomstats", + "required": false, + "since": "4.18.1", + "type": "boolean" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the status of the storage pool", + "length": 255, + "name": "status", + "required": false, "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" + "description": "list storage pools belonging to the specific cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the Zone ID for the storage pool", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, - {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the storage pool path", + "length": 255, + "name": "path", + "required": false, "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "the IP address for the storage pool", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "description": "the ID of the storage pool", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the storage pool", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "response": [ + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the VPC", + "description": "the ID of the storage pool", "name": "id", "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, - { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + {}, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "the tags for the storage pool", + "name": "tags", "type": "string" - } - ] - }, - { - "description": "Changes out-of-band management interface password on the host and updates the interface configuration in CloudStack if the operation succeeds, else reverts the old password", - "isasync": true, - "name": "changeOutOfBandManagementPassword", - "params": [ + }, { - "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", - "length": 255, - "name": "password", - "required": false, + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction", - "response": [ + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, { - "description": "the operation result description", - "name": "description", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, - {}, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, - {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the storage pool type", + "name": "type", "type": "string" - } - ], - "since": "4.9.0" + }, + { + "description": "the storage pool details", + "name": "details", + "type": "map" + }, + {} + ] }, { - "description": "Lists all IPv6 firewall rules", + "description": "Updates a hypervisor capabilities.", "isasync": false, - "name": "listIpv6FirewallRules", + "name": "updateHypervisorCapabilities", "params": [ { - "description": "List resources by tags (key/value pairs)", + "description": "the hypervisor for which the hypervisor capabilities are to be updated", "length": 255, - "name": "tags", + "name": "hypervisor", "required": false, - "type": "map" + "since": "4.19.1", + "type": "string" }, { - "description": "list ipv6 firewall rules by network ID", + "description": "set true to enable VM snapshots for this hypervisor", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "vmsnapshotenabled", "required": false, - "type": "uuid" + "since": "4.16.0", + "type": "boolean" }, { - "description": "List by keyword", + "description": "the hypervisor version for which the hypervisor capabilities are to be updated", "length": 255, - "name": "keyword", + "name": "hypervisorversion", "required": false, + "since": "4.19.1", "type": "string" }, { - "description": "", + "description": "the maximum number of the hypervisor hosts per cluster ", "length": 255, - "name": "pagesize", + "name": "maxhostspercluster", "required": false, + "since": "4.16.0", "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "set true to enable storage motion support for this hypervisor", "length": 255, - "name": "listall", + "name": "storagemotionenabled", "required": false, + "since": "4.16.0", "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the max number of Guest VMs per host for this hypervisor.", "length": 255, - "name": "fordisplay", + "name": "maxguestslimit", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "", + "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", "length": 255, - "name": "page", + "name": "maxdatavolumeslimit", "required": false, + "since": "4.16.0", "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "set true to enable security group for this hypervisor.", "length": 255, - "name": "isrecursive", + "name": "securitygroupenabled", "required": false, "type": "boolean" }, { - "description": "Lists ipv6 firewall rule with the specified ID", + "description": "ID of the hypervisor capability", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "related": "listHypervisorCapabilities,updateHypervisorCapabilities", "required": false, "type": "uuid" + } + ], + "related": "listHypervisorCapabilities", + "response": [ + { + "description": "true if security group is supported", + "name": "securitygroupenabled", + "type": "boolean" }, { - "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": "true if storage motion is supported", + "name": "storagemotionenabled", + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" }, { - "description": "list ipv6 firewall rules by traffic type - ingress or egress", - "length": 255, - "name": "traffictype", - "required": false, + "description": "the hypervisor version", + "name": "hypervisorversion", "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" - } - ], - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", - "response": [ - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the ID of the hypervisor capabilities row", + "name": "id", "type": "string" }, { @@ -25865,168 +23344,37 @@ var preCache = `{ "type": "integer" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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 protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the hypervisor type", + "name": "hypervisor", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" + "description": "the maximum number of guest vms recommended for this hypervisor", + "name": "maxguestslimit", + "type": "long" } - ] + ], + "since": "3.0.0" }, { - "description": "List VM Schedules.", + "description": "Find hosts suitable for migrating a virtual machine.", "isasync": false, - "name": "listVMSchedule", + "name": "findHostsForMigration", "params": [ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, - { - "description": "ID of VM schedule", - "length": 255, - "name": "id", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", - "required": false, - "type": "uuid" - }, - { - "description": "ID of the VM for which schedule is to be defined", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "ID of VM schedule", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" - }, { "description": "List by keyword", "length": 255, @@ -26035,284 +23383,269 @@ var preCache = `{ "type": "string" }, { - "description": "Action taken by schedule", + "description": "find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM", "length": 255, - "name": "action", - "required": false, - "type": "string" + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" } ], - "related": "createVMSchedule,updateVMSchedule", + "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, - {}, { - "description": "ID of virtual machine", - "name": "virtualmachineid", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "Action", - "name": "action", - "type": "action" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "Timezone of the schedule", - "name": "timezone", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "Description of VM schedule", - "name": "description", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the ID of VM schedule", - "name": "id", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, + {}, { - "description": "Date from which the schedule is active", - "name": "startdate", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", "type": "date" }, - {} - ], - "since": "4.19.0" - }, - { - "description": "List resource detail(s)", - "isasync": false, - "name": "listResourceDetails", - "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", "type": "integer" }, { - "description": "list by resource id", - "length": 255, - "name": "resourceid", - "required": false, + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "if set to true, only details marked with display=true, are returned. False by default", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.3", - "type": "boolean" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "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": "the host hypervisor", + "name": "hypervisor", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "events available for the host", + "name": "events", "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" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "list by key, value. Needs to be passed only along with key", - "length": 255, - "name": "value", - "required": false, - "since": "4.4", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "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 amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "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": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "list by resource type", - "length": 255, - "name": "resourcetype", - "required": true, + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "list by key", - "length": 255, - "name": "key", - "required": false, - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "listTags", - "response": [ - {}, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" - } - ], - "since": "4.2" - }, - { - "description": "Attempts to live patch systemVMs - CPVM, SSVM ", - "isasync": true, - "name": "patchSystemVm", - "params": [ - { - "description": "If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" }, { - "description": "patches systemVM - CPVM/SSVM with the specified ID", - "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": false, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { @@ -26320,491 +23653,388 @@ var preCache = `{ "name": "jobstatus", "type": "integer" }, - {} - ], - "since": "4.17.0" - }, - { - "description": "Creates a network offering.", - "isasync": false, - "name": "createNetworkOffering", - "params": [ { - "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", - "length": 255, - "name": "details", - "required": false, - "since": "4.2.0", - "type": "map" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { - "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", - "length": 255, - "name": "keepaliveenabled", - "required": false, + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "desired service capabilities as part of network offering", - "length": 255, - "name": "servicecapabilitylist", - "required": false, - "type": "map" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "true if network offering supports persistent networks; defaulted to false if not specified", - "length": 255, - "name": "ispersistent", - "required": false, - "type": "boolean" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", - "required": false, - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "length": 255, - "name": "egressdefaultpolicy", - "required": false, + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "guest type of the network offering: Shared or Isolated", - "length": 255, - "name": "guestiptype", - "required": true, + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "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": "the host version", + "name": "version", + "type": "string" }, { - "description": "the availability of network offering. The default value is Optional. Another value is Required, which will make it as the default network offering for new networks ", - "length": 255, - "name": "availability", - "required": false, - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the ID of the containing domain(s), null for public offerings", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "list" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "true if network offering is meant to be used for VPC, false otherwise.", - "length": 255, - "name": "forvpc", - "required": false, - "type": "boolean" + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" }, { - "description": "data transfer rate in megabits per second allowed", - "length": 255, - "name": "networkrate", - "required": false, - "type": "integer" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "the display text of the network offering, defaults to the value of 'name'.", - "length": 255, - "name": "displaytext", - "required": false, + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, + {}, { - "description": "the name of the network offering", - "length": 255, - "name": "name", - "required": true, + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "maximum number of concurrent connections supported by the network offering", - "length": 255, - "name": "maxconnections", - "required": false, - "type": "integer" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "services supported by the network offering", - "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", - "length": 255, - "name": "fortungsten", - "required": false, - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "true if the network offering is IP conserve mode enabled", - "length": 255, - "name": "conservemode", - "required": false, - "type": "boolean" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "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 OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "true if network offering supports vlans", - "length": 255, - "name": "specifyvlan", - "required": false, + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", - "length": 255, - "name": "serviceproviderlist", - "required": false, - "type": "map" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "the traffic type for the network offering. Supported type in current release is GUEST only", - "length": 255, - "name": "traffictype", - "required": true, + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the service offering ID used by virtual router provider", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { - "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", - "length": 255, - "name": "internetprotocol", - "required": false, - "since": "4.17.0", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", - "length": 255, - "name": "specifyipranges", - "required": false, - "type": "boolean" - } - ], - "related": "listNetworkOfferings", - "response": [ - { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "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 last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "true if migrating a vm to this host requires storage motion, false otherwise", + "name": "requiresStorageMotion", + "type": "boolean" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, + {} + ] + }, + { + "description": "Enable a Cisco Nexus VSM device", + "isasync": true, + "name": "enableCiscoNexusVSM", + "params": [ { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" + "description": "Id of the Cisco Nexus 1000v VSM device to be enabled", + "length": 255, + "name": "id", + "related": "listCiscoNexusVSMs,enableCiscoNexusVSM,disableCiscoNexusVSM", + "required": true, + "type": "uuid" + } + ], + "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", + "response": [ + { + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", + "type": "string" }, { - "description": "the name of the network offering", - "name": "name", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "type": "boolean" + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", + "type": "string" }, + {}, { - "description": "the id of the network offering", - "name": "id", - "type": "string" + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", + "type": "string" }, - {}, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" - }, + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", + "type": "string" + } + ] + }, + { + "description": "Return true if the specified account is allowed to create offerings with tags.", + "isasync": false, + "name": "isAccountAllowedToCreateOfferingsWithTags", + "params": [ { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Account UUID", + "length": 255, + "name": "id", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", + "description": "is domain admin allowed to create offerings with tags", + "name": "isallowed", "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Dedicate an existing cluster", + "description": "Adds VM to specified network by creating a NIC", "isasync": true, - "name": "dedicateCluster", + "name": "addNicToVirtualMachine", "params": [ { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "description": "Mac Address for the new network", "length": 255, - "name": "account", + "name": "macaddress", "required": false, "type": "string" }, { - "description": "the ID of the containing domain", + "description": "IP Address for the new network", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "ipaddress", + "required": false, + "type": "string" + }, + { + "description": "Network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" }, { - "description": "the ID of the Cluster", + "description": "Virtual Machine ID", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": true, "type": "uuid" + }, + { + "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", + "length": 255, + "name": "dhcpoptions", + "required": false, + "type": "map" } ], - "related": "listDedicatedClusters", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "response": [ { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the domain ID of the cluster", - "name": "domainid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the Account ID of the cluster", - "name": "accountid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { @@ -26812,188 +24042,241 @@ var preCache = `{ "name": "jobid", "type": "string" }, - {}, { - "description": "the name of the cluster", - "name": "clustername", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Creates an IP forwarding rule", - "isasync": true, - "name": "createIpForwardingRule", - "params": [ - { - "description": "the end port for the rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - }, - { - "description": "the start port for the rule", - "length": 255, - "name": "startport", - "required": true, - "type": "integer" - }, - { - "description": "the public IP address ID of the forwarding rule, already associated via associateIp", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - }, - { - "description": "the protocol for the rule. Valid values are TCP or UDP.", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, - { - "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, - { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", - "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" - } - ], - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", - "response": [ - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - {}, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, + {}, { - "description": "the list of resource tags associated with the rule", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -27002,564 +24285,786 @@ var preCache = `{ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "list" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "type": "set" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" - } - ] - }, - { - "description": "Lists volume metrics", - "isasync": false, - "name": "listVolumesMetrics", - "params": [ - { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "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, + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "listsystemvms", - "required": false, - "since": "4.18", - "type": "boolean" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "displayvolume", - "required": false, - "since": "4.4", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the cluster id the disk volume belongs to", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, - { - "description": "list volumes on specified host", - "length": 255, + "description": "the ID of the host for the virtual machine", "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "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": "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": "the type of disk volume", - "length": 255, - "name": "type", - "required": false, "type": "string" }, { - "description": "the pod id the disk volume belongs to", - "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the IDs of the volumes, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": false, - "since": "4.9", + "description": "NICs of the VNF appliance", + "name": "vnfnics", "type": "list" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": false, - "type": "uuid" + "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 project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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": "the account associated with the tag", + "name": "account", + "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" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "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" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "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 name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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 name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "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" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the name of the disk volume", - "length": 255, - "name": "name", - "required": false, + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "list volumes by disk offering", - "length": 255, + "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", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": false, - "since": "4.4", - "type": "uuid" - }, - { - "description": "the ID of the storage pool, available to ROOT admin only", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "4.3", "type": "string" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "type": "boolean" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the total disk iops", - "name": "diskiopstotal", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, - {}, { - "description": "ID of the disk volume", - "name": "id", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, + {}, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the project id of the vpn", + "description": "the project id of the vm", "name": "projectid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], "type": "set" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "disk size in GiB", - "name": "sizegb", + "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": "state of the virtual machine", - "name": "vmstate", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" - }, - { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { @@ -27568,310 +25073,474 @@ var preCache = `{ "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, + {}, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, - {}, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - } - ], - "since": "4.9.3" - }, - { - "description": "Lists the network Interfaces of elastistor", - "isasync": false, - "name": "listElastistorInterface", - "params": [ - { - "description": "controller id", - "length": 255, - "name": "controllerid", - "required": false, - "type": "string" - } - ], - "related": "listElastistorVolume", - "response": [ + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, { - "description": "deduplication", - "name": "deduplication", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "graceallowed", - "name": "graceallowed", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "compression", - "name": "compression", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, - {}, - {}, { - "description": "synchronization", - "name": "sync", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the id of the volume", - "name": "id", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the volume", - "name": "name", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" } ] }, { - "description": "Lists all possible details and their options for a resource type such as a VM or a template", + "description": "Lists all static routes", "isasync": false, - "name": "listDetailOptions", + "name": "listStaticRoutes", "params": [ { - "description": "the resource type such as UserVm, Template etc.", + "description": "", "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the UUID of the resource (optional)", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "resourceid", + "name": "isrecursive", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list static routes by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "Map of all possible details and their possible list of values", - "name": "details", - "type": "map" - } - ], - "since": "4.13" - }, - { - "description": "Lists SSL certificates", - "isasync": false, - "name": "listSslCerts", - "params": [ - { - "description": "ID of SSL certificate", + "description": "list static routes by vpc id", "length": 255, - "name": "certid", - "related": "uploadSslCert,listSslCerts", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "Load balancer rule ID", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "Account ID", + "description": "list static routes by gateway id", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "required": false, "type": "uuid" }, { - "description": "Project that owns the SSL certificate", + "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": "list static route by id", + "length": 255, + "name": "id", + "related": "listStaticRoutes", + "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 by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "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" } ], - "related": "uploadSslCert", + "related": "", "response": [ { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "the ID of static route", + "name": "id", "type": "string" }, { - "description": "account for the certificate", - "name": "account", + "description": "the project name of the static route", + "name": "project", "type": "string" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "Next hop of the static route", + "name": "nexthop", + "type": "string" }, {}, + {}, { - "description": "certificate chain", - "name": "certchain", + "description": "the ID of the domain associated with the static route", + "name": "domainid", "type": "string" }, - {}, { - "description": "name", - "name": "name", + "description": "static route CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "the domain path associated with the static route", + "name": "domainpath", "type": "string" }, + { + "description": "the list of resource tags associated with static route", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the project name of the certificate", - "name": "project", + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "IP of VPC gateway the route is created for", + "name": "vpcgatewayip", "type": "string" }, { - "description": "SSL certificate ID", - "name": "id", + "description": "VPC gateway the route is created for", + "name": "vpcgatewayid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the static route", + "name": "account", "type": "string" }, { - "description": "the project id of the certificate", + "description": "the project id of the static route", "name": "projectid", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the domain associated with the static route", + "name": "domain", "type": "string" }, { - "description": "certificate", - "name": "certificate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the state of the static route", + "name": "state", "type": "string" } ] }, { - "description": "List private gateways", + "description": "Lists all public ip addresses", "isasync": false, - "name": "listPrivateGateways", + "name": "listPublicIpAddresses", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "lists the specified IP address", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "ipaddress", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "true if range is dedicated for external network provider", + "length": 255, + "name": "forprovider", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "lists all public IP addresses by physical network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "limits search results to allocated public IP addresses", + "length": 255, + "name": "allocatedonly", + "required": false, + "type": "boolean" + }, + { + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" + }, + { + "description": "lists all public IP addresses by zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "list private gateway by id", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "lists IP address by ID", "length": 255, "name": "id", - "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "list gateways by state", + "description": "lists all public IP addresses by source network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "since": "4.13.0", + "type": "uuid" + }, + { + "description": "lists all public IP addresses associated to the network specified", + "length": 255, + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "lists all public IP addresses by state", "length": 255, "name": "state", "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": "list only static NAT IP addresses", + "length": 255, + "name": "isstaticnat", + "required": false, + "type": "boolean" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -27880,54 +25549,71 @@ var preCache = `{ "type": "string" }, { - "description": "list gateways by ip address", + "description": "the virtual network for the IP address", "length": 255, - "name": "ipaddress", + "name": "forvirtualnetwork", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list gateways by vlan", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "vlan", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only IPs used for load balancing", "length": 255, - "name": "listall", + "name": "forloadbalancing", "required": false, "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "true if range is dedicated for system VMs", "length": 255, - "name": "isrecursive", + "name": "forsystemvms", "required": false, + "since": "4.20.0", "type": "boolean" }, { - "description": "list gateways by vpc", + "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": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "lists all public IP addresses by VLAN ID", + "length": 255, + "name": "vlanid", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, "type": "uuid" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "page", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "List by keyword", + "description": "list only source NAT IP addresses", "length": 255, - "name": "keyword", + "name": "issourcenat", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "List IPs belonging to the VPC", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { "description": "", @@ -27937,447 +25623,597 @@ var preCache = `{ "type": "integer" } ], - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ - {}, { - "description": "ACL Id set for private gateway", - "name": "aclid", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, - {}, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the gateway", - "name": "gateway", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" + }, + { + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the project name of the address", + "name": "project", "type": "string" }, + {}, { - "description": "VPC name the private gateway belongs to", + "description": "public IP address id", + "name": "id", + "type": "string" + }, + { + "description": "VPC name the ip belongs to", "name": "vpcname", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "Source Nat enable status", - "name": "sourcenatsupported", + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", "type": "boolean" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", - "type": "string" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the id of the private gateway", - "name": "id", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", "type": "boolean" }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the project name of the private gateway", - "name": "project", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if range is dedicated for external network providers", + "name": "forprovider", + "type": "boolean" + }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" - } - ] - }, - { - "description": "Update the default Ip of a VM Nic", - "isasync": true, - "name": "updateVmNicIp", - "params": [ + }, { - "description": "Secondary IP Address", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the ID of the nic to which you want to assign private IP", - "length": 255, - "name": "nicid", - "related": "listNics", - "required": true, - "type": "uuid" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "type": "string" + }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated with ip address", + "name": "tags", "response": [ { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "tag value", + "name": "value", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" + } + ] + }, + { + "description": "Lists OpenDyalight controllers", + "isasync": false, + "name": "listOpenDaylightControllers", + "params": [ + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the ID of a OpenDaylight Controller", + "length": 255, + "name": "id", + "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", + "required": false, + "type": "uuid" + } + ], + "related": "addOpenDaylightController,deleteOpenDaylightController", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name assigned to the controller", + "name": "name", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the url of the controller api", + "name": "url", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the username to authenticate to the controller", + "name": "username", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "device id of the controller", + "name": "id", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, + {} + ] + }, + { + "description": "Adds a BigSwitch BCF Controller device", + "isasync": true, + "name": "addBigSwitchBcfDevice", + "params": [ { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "Username of the BigSwitch BCF Controller.", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "Hostname of ip address of the BigSwitch BCF Controller.", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "NAT support of the BigSwitch BCF Controller.", + "length": 255, + "name": "nat", + "required": true, + "type": "boolean" + }, + { + "description": "Password of the BigSwitch BCF Controller.", + "length": 255, + "name": "password", + "required": true, + "type": "string" + } + ], + "related": "listBigSwitchBcfDevices", + "response": [ + { + "description": "the controller password", + "name": "password", + "type": "string" + }, + { + "description": "NAT support", + "name": "nat", + "type": "boolean" }, {}, { - "description": "the user's name who deployed the virtual machine", + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", + "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": "device name", + "name": "bigswitchdevicename", + "type": "string" + }, + { + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "the controller username", "name": "username", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the controller Ip address", + "name": "hostname", + "type": "string" + } + ], + "since": "4.6.0" + }, + { + "description": "Changes the default NIC on a VM", + "isasync": true, + "name": "updateDefaultNicForVirtualMachine", + "params": [ + { + "description": "NIC ID", + "length": 255, + "name": "nicid", + "related": "listNics", + "required": true, + "type": "uuid" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "Virtual Machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "response": [ + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + {}, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, { "description": " an alternate display text of the template for the virtual machine", "name": "templatedisplaytext", "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", + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, { "description": "the description of the security group", "name": "description", @@ -28389,121 +26225,126 @@ var preCache = `{ "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the protocol of the security group rule", "name": "protocol", @@ -28512,11 +26353,6 @@ var preCache = `{ ], "type": "set" }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -28531,11 +26367,6 @@ var preCache = `{ "name": "domain", "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", @@ -28551,60 +26382,65 @@ var preCache = `{ "name": "project", "type": "string" }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, { "description": "customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "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", + "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": "account owning the security group rule", + "name": "account", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -28613,8 +26449,13 @@ var preCache = `{ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -28623,23 +26464,23 @@ var preCache = `{ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], @@ -28651,15 +26492,20 @@ var preCache = `{ "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "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": "the type of the ICMP message response", "name": "icmptype", @@ -28671,302 +26517,169 @@ var preCache = `{ "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "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" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, - {}, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "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 project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", - "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 domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "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 name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { @@ -28975,103 +26688,57 @@ var preCache = `{ "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { "description": "the project id of the vm", "name": "projectid", "type": "string" }, - {}, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, - { - "description": "the group name of the virtual machine", - "name": "group", - "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 ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -29080,591 +26747,937 @@ var preCache = `{ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" - } - ] - }, - { - "description": "Updates load balancer stickiness policy", - "isasync": true, - "name": "updateLBStickinessPolicy", - "params": [ - { - "description": "id of lb stickiness policy", - "length": 255, - "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", - "required": true, - "type": "uuid" - }, - { - "description": "an optional field, whether to the display the policy to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" }, { - "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", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" - } - ], - "related": "createLBStickinessPolicy,listLBStickinessPolicies", - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the account of the Stickiness policy", - "name": "account", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, - {}, { - "description": "the state of the policy", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the LB Stickiness policy ID", - "name": "id", + "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": "the params of the policy", - "name": "params", - "type": "map" - } - ], - "type": "list" - }, - { - "description": "the domain of the Stickiness policy", - "name": "domain", - "type": "string" - }, - {}, - { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - } - ], - "since": "4.4" - }, - { - "description": "Lists all Pods.", - "isasync": false, - "name": "listPods", - "params": [ - { - "description": "list Pods by Zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "list pods by allocation state", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, - { - "description": "list Pods by name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list Pods by ID", - "length": 255, - "name": "id", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "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" - }, - { - "description": "flag to display the capacity of the pods", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" - } - ], - "related": "updatePod,createManagementNetworkIpRange", - "response": [ - { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ + "description": "the type of the nic", + "name": "type", + "type": "string" + }, { - "description": "indicates Vlan ID for the range", + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "ID of the VLAN/VNI if available", "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the gateway for the range", - "name": "gateway", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the capacity of the Pod", - "name": "capacity", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "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 ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "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 template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the capacity name", - "name": "name", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the project name of the affinity group", + "name": "project", + "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the description of the affinity group", + "name": "description", + "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "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 availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the Pod", - "name": "name", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, - {}, - {}, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "OS type id of the vm", + "name": "ostypeid", "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 control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the ID of the Pod", - "name": "id", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "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 pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + } + ] + }, + { + "description": "Generate DRS plan for a cluster", + "isasync": false, + "name": "generateClusterDrsPlan", + "params": [ + { + "description": "Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting", + "length": 255, + "name": "migrations", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the Cluster", + "length": 255, + "name": "id", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "related": "executeClusterDrsPlan", + "response": [ + {}, + { + "description": "unique ID of the drs plan for cluster", + "name": "id", + "type": "string" + }, + { + "description": "Start event Id of the DRS Plan", + "name": "eventid", "type": "string" }, + { + "description": "Status of DRS Plan", + "name": "status", + "type": "status" + }, + {}, + { + "description": "List of migrations", + "name": "migrations", + "type": "list" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "Id of the cluster", + "name": "clusterid", + "type": "string" + }, + { + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] + }, + {} + ], + "since": "4.19.0" }, { - "description": "Starts an existing internal lb vm.", - "isasync": true, - "name": "startInternalLoadBalancerVM", + "description": "Deletes a user for an account", + "isasync": false, + "name": "deleteUser", "params": [ { - "description": "the ID of the internal lb vm", + "description": "id of the user to be deleted", "length": 255, "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": true, "type": "uuid" } ], - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "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 name of the router", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ] + }, + { + "description": "Initiates the specified power action to the host's out-of-band management interface", + "isasync": true, + "name": "issueOutOfBandManagementPowerAction", + "params": [ + { + "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", + "length": 255, + "name": "timeout", + "required": false, + "type": "long" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + }, + { + "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", + "length": 255, + "name": "action", + "required": true, + "type": "string" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", + "response": [ + { + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "the operation result description", + "name": "description", + "type": "string" + }, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + {}, + { + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" + }, + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", "type": "boolean" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the operation result", + "name": "status", "type": "boolean" + } + ], + "since": "4.9.0" + }, + { + "description": "Create a new Shared File System of specified size and disk offering, attached to the given network", + "isasync": true, + "name": "createSharedFileSystem", + "params": [ + { + "description": "the zone id.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the name of the shared filesystem.", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the description for the shared filesystem.", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the account associated with the shared filesystem. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", + "description": "the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.", + "length": 255, + "name": "filesystem", + "required": true, + "type": "string" + }, + { + "description": "the size of the shared filesystem in GiB", + "length": 255, + "name": "size", + "required": false, + "type": "long" + }, + { + "description": "the provider to be used for the shared filesystem. The list of providers can be fetched by using the listSharedFileSystemProviders API.", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + }, + { + "description": "the project associated with the shared filesystem. Mutually exclusive with account parameter", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "network to attach the shared filesystem to", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "min iops", + "length": 255, + "name": "miniops", + "required": false, + "type": "long" + }, + { + "description": "max iops", + "length": 255, + "name": "maxiops", + "required": false, + "type": "long" + }, + { + "description": "the service offering to use for the shared filesystem instance hosting the data. The offering should be HA enabled and the cpu count and memory size should be greater than equal to sharedfsvm.min.cpu.count and sharedfsvm.min.ram.size respectively", + "length": 255, "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "the domain ID associated with the shared filesystem. If used with the account parameter returns the shared filesystem associated with the account for the specified domain.If account is NOT provided then the shared filesystem will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "the disk offering to use for the underlying storage. This will define the size and other specifications like encryption and qos for the shared filesystem.", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" + } + ], + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "response": [ + { + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "role of the domain router", - "name": "role", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "the list of nics associated with the router", + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + {}, + { + "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -29673,732 +27686,838 @@ var preCache = `{ "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" } ], - "type": "set" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - {}, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" + "type": "list" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "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 id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], - "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "type": "set" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, + {}, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" }, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, - {}, { - "description": "the host ID for the router", - "name": "hostid", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.20.0" }, { - "description": "Updates a disk offering.", + "description": "Deletes network device.", "isasync": false, - "name": "updateDiskOffering", + "name": "deleteNetworkDevice", "params": [ { - "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", + "description": "Id of network device to delete", "length": 255, - "name": "tags", - "required": false, - "since": "4.15", - "type": "string" + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "burst bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadratemax", - "required": false, - "since": "4.15", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "an optional field, whether to display the offering to the end user or not.", - "length": 255, - "name": "displayoffering", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ] + }, + { + "description": "Updates image store read-only status", + "isasync": false, + "name": "updateImageStore", + "params": [ + { + "description": "Image Store UUID", + "length": 255, + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": true, + "type": "uuid" }, { - "description": "length (in seconds) of the burst", + "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", "length": 255, - "name": "iopswriteratemaxlength", + "name": "readonly", "required": false, - "since": "4.15", - "type": "long" + "type": "boolean" }, { - "description": "burst requests read rate of the disk offering", + "description": "The number of bytes CloudStack can use on this image storage.\n\tNOTE: this will be overwritten by the StatsCollector as soon as there is a SSVM to query the storage.", "length": 255, - "name": "iopsreadratemax", + "name": "capacitybytes", "required": false, - "since": "4.15", "type": "long" }, { - "description": "updates name of the disk offering with this value", + "description": "The new name for the Image Store.", "length": 255, "name": "name", "required": false, "type": "string" + } + ], + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "response": [ + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "burst bytes write rate of the disk offering", - "length": 255, - "name": "byteswriteratemax", - "required": false, - "since": "4.15", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "burst io requests write rate of the disk offering", - "length": 255, - "name": "iopswriteratemax", - "required": false, - "since": "4.15", - "type": "long" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopsreadratemaxlength", - "required": false, - "since": "4.15", - "type": "long" + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "bytesreadratemaxlength", - "required": false, - "since": "4.15", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "bytes write rate of the disk offering", - "length": 255, - "name": "byteswriterate", - "required": false, - "since": "4.15", + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "sort key of the disk offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, { - "description": "bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadrate", - "required": false, - "since": "4.15", - "type": "long" + "description": "the name of the image store", + "name": "name", + "type": "string" }, { - "description": "ID of the disk offering", - "length": 255, - "name": "id", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", - "required": false, - "since": "4.13", + "description": "the url of the image store", + "name": "url", "type": "string" }, + {}, { - "description": "the cache mode to use for this disk offering", - "length": 255, - "name": "cachemode", - "required": false, - "since": "4.15", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "io requests read rate of the disk offering", - "length": 255, - "name": "iopsreadrate", - "required": false, - "since": "4.15", - "type": "long" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "updates alternate display text of the disk offering with this value", - "length": 4096, - "name": "displaytext", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + } + ], + "since": "4.15.0" + }, + { + "description": "Assigns virtual machine or a list of virtual machines to a load balancer rule.", + "isasync": true, + "name": "assignToLoadBalancerRule", + "params": [ + { + "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75", + "length": 255, + "name": "vmidipmap", "required": false, - "type": "string" + "since": "4.4", + "type": "map" }, { - "description": "io requests write rate of the disk offering", + "description": "the ID of the load balancer rule", "length": 255, - "name": "iopswriterate", - "required": false, - "since": "4.15", - "type": "long" + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "required": true, + "type": "uuid" }, { - "description": "length (in seconds) of the burst", + "description": "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)", "length": 255, - "name": "byteswriteratemaxlength", + "name": "virtualmachineids", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": false, - "since": "4.15", - "type": "long" + "type": "list" } ], - "related": "createDiskOffering,listDiskOfferings", "response": [ + {}, + {}, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ] + }, + { + "description": "Configure the storage access groups on zone/pod/cluster/host and storage, accordingly connections to the storage pools", + "isasync": true, + "name": "configureStorageAccess", + "params": [ { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "UUID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "UUID of the host", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "comma separated list of storage access groups for connecting the storage pools and the hosts", + "length": 255, + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", + "type": "list" }, - {}, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", - "type": "string" + "description": "UUID of the Storage Pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "UUID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "UUID of the pod", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.21.0" + }, + { + "description": "Lists all pending asynchronous jobs for the account.", + "isasync": false, + "name": "listAsyncJobs", + "params": [ { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "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": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "The id of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": false, + "since": "4.19", + "type": "uuid" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "queryAsyncJobResult", + "response": [ { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the domain that executed the async command", + "name": "domainpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": " the created date of the job", + "name": "created", + "type": "date" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the account that executed the async command", + "name": "account", "type": "string" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "the result type", + "name": "jobresulttype", + "type": "string" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "the management server name of the host", + "name": "managementservername", + "type": "string" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the account id that executed the async command", + "name": "accountid", + "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "the async command executed", + "name": "cmd", + "type": "string" }, - {}, { - "description": "unique ID of the disk offering", - "name": "id", + "description": " the completed date of the job", + "name": "completed", + "type": "date" + }, + { + "description": "the domain id that executed the async command", + "name": "domainid", "type": "string" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", + "type": "string" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "the user that executed the async command", + "name": "userid", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "delete Tungsten-Fabric address group", - "isasync": true, - "name": "deleteTungstenFabricAddressGroup", + "description": "Archive one or more alerts.", + "isasync": false, + "name": "archiveAlerts", "params": [ { - "description": "the uuid of Tungsten-Fabric address group", + "description": "archive by alert type", "length": 255, - "name": "addressgroupuuid", - "required": true, + "name": "type", + "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "the IDs of the alerts", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "ids", + "related": "listAlerts,listAlertTypes", + "required": false, + "type": "list" + }, + { + "description": "start date range to archive alerts (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": "end date range to archive alerts (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" } ], "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {} + } ] }, { - "description": "Stops a running CloudManaged Kubernetes cluster", - "isasync": true, - "name": "stopKubernetesCluster", + "description": "Deletes a Cisco Vnmc controller", + "isasync": false, + "name": "deleteCiscoVnmcResource", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "Cisco Vnmc resource ID", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "name": "resourceid", + "related": "addCiscoVnmcResource,listCiscoVnmcResources", "required": true, "type": "uuid" } ], "response": [ - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -30406,145 +28525,162 @@ var preCache = `{ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the 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": "Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", + "description": "Creates a secondary storage selector, described by the heuristic rule.", "isasync": false, - "name": "removeVirtualMachinesFromKubernetesCluster", + "name": "createSecondaryStorageSelector", "params": [ { - "description": "List by keyword", + "description": "The description of the heuristic rule.", "length": 255, - "name": "keyword", - "required": false, + "name": "description", + "required": true, "type": "string" }, { - "description": "the IDs of the VMs to remove from the cluster", + "description": "The name identifying the heuristic rule.", "length": 255, - "name": "virtualmachineids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "name", "required": true, - "type": "list" + "type": "string" }, { - "description": "", + "description": "The zone in which the heuristic rule will be applied.", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the ID of the Kubernetes cluster", + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "name": "type", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", + "length": 65535, + "name": "heuristicrule", + "required": true, + "type": "string" } ], - "related": "", + "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", "response": [ + {}, + { + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", + "type": "string" + }, + { + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", + "type": "string" + }, + { + "description": "When the heuristic was created.", + "name": "created", + "type": "date" + }, + { + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "Description of the heuristic.", + "name": "description", + "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", + "description": "ID of the heuristic.", + "name": "id", "type": "string" }, - {}, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", + "type": "string" + }, + {} ], "since": "4.19.0" }, { - "description": "Adds account to a project", + "description": "Adds a Brocade VCS Switch", "isasync": true, - "name": "addAccountToProject", + "name": "addBrocadeVcsDevice", "params": [ { - "description": "email to which invitation to the project is going to be sent", + "description": "Credentials to access the Brocade VCS Switch API", "length": 255, - "name": "email", - "required": false, + "name": "password", + "required": true, "type": "string" }, { - "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", + "description": "the Physical Network ID", "length": 255, - "name": "roletype", - "required": false, - "type": "string" + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "name of the account to be added to the project", + "description": "Hostname of ip address of the Brocade VCS Switch.", "length": 255, - "name": "account", - "required": false, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "ID of the project to add the account to", + "description": "Credentials to access the Brocade VCS Switch API", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "username", "required": true, - "type": "uuid" - }, - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": false, - "type": "uuid" + "type": "string" } ], + "related": "listBrocadeVcsDevices", "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "name of the provider", + "name": "provider", "type": "string" }, { @@ -30552,229 +28688,261 @@ var preCache = `{ "name": "jobid", "type": "string" }, + {}, + { + "description": "the principal switch Ip address", + "name": "hostname", + "type": "string" + }, + {}, + { + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", + "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": "device name", + "name": "brocadedevicename", + "type": "string" }, - {} - ], - "since": "3.0.0" + { + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", + "type": "string" + } + ] }, { - "description": "Lists all available snapshots for the account.", - "isasync": false, - "name": "listSnapshots", + "description": "Deleting resource tag(s)", + "isasync": true, + "name": "deleteTags", "params": [ { - "description": "the ID of the disk volume", + "description": "Delete tags matching key/value pairs", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the IDs of the snapshots, mutually exclusive with id", + "description": "Delete tags for resource id(s)", "length": 255, - "name": "ids", - "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", - "required": false, - "since": "4.9", + "name": "resourceids", + "required": true, "type": "list" }, { - "description": "lists snapshot by snapshot ID", + "description": "Delete tag by resource type", "length": 255, - "name": "id", - "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", - "required": false, - "type": "uuid" - }, + "name": "resourcetype", + "required": true, + "type": "string" + } + ], + "response": [ + {}, { - "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, + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.0.0" + }, + { + "description": "create Tungsten-Fabric tag type", + "isasync": true, + "name": "createTungstenFabricTagType", + "params": [ { - "description": "list snapshots by zone id", + "description": "the ID of zone", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", - "required": false, + "required": true, "type": "uuid" }, { - "description": "If set to false, list templates across zones and their storages", + "description": "Tungsten-Fabric tag type name", "length": 255, - "name": "showunique", - "required": false, - "since": "4.19.0", - "type": "boolean" - }, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "listTungstenFabricTagType", + "response": [ { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, + {}, { - "description": "ID of the storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "4.19", - "type": "uuid" + "description": "Tungsten-Fabric tag type name", + "name": "name", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { - "description": "", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the \"logout\" command has been issued or the session has expired.", + "isasync": false, + "name": "login", + "params": [ + { + "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", "length": 255, - "name": "page", + "name": "domainId", "required": false, - "type": "integer" + "type": "long" }, { - "description": "valid values are MANUAL or RECURRING.", + "description": "Username", "length": 255, - "name": "snapshottype", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", + "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", "length": 255, - "name": "intervaltype", + "name": "domain", "required": false, "type": "string" }, { - "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", + "description": "Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", "length": 255, - "name": "locationtype", - "required": false, - "since": "4.19.0", + "name": "password", + "required": true, + "type": "string" + } + ], + "related": "oauthlogin", + "response": [ + { + "description": "the account name the user belongs to", + "name": "account", "type": "string" }, { - "description": "ID of the image or image cache store", - "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": false, - "since": "4.19", - "type": "uuid" + "description": "Is two factor authentication verified", + "name": "is2faverified", + "type": "string" }, { - "description": "lists snapshot by snapshot name", - "length": 255, - "name": "name", - "required": false, + "description": "Domain ID that the user belongs to", + "name": "domainid", "type": "string" - } - ], - "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", - "response": [ + }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "last name of the user", + "name": "lastname", + "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Username", + "name": "username", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "Is user registered", + "name": "registered", + "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "Management Server ID that the user logged to", + "name": "managementserverid", "type": "string" }, + {}, { - "description": "name of the disk volume", - "name": "volumename", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "type": "string" }, + {}, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" + }, + { + "description": "user time zone", + "name": "timezone", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "first name of the user", + "name": "firstname", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "user time zoneoffset", + "name": "timezoneoffset", + "type": "string" + }, + { + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "type": "string" }, { @@ -30783,522 +28951,551 @@ var preCache = `{ "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "User ID", + "name": "userid", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "Two factor authentication provider", + "name": "providerfor2fa", "type": "string" - }, + } + ] + }, + { + "description": "Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules", + "isasync": true, + "name": "restartNetwork", + "params": [ { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "length": 255, + "name": "livepatch", + "required": false, + "since": "4.17.0", + "type": "boolean" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" + "description": "If cleanup old network elements", + "length": 255, + "name": "cleanup", + "required": false, + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Turn the network into a network with redundant routers.", + "length": 255, + "name": "makeredundant", + "required": false, + "since": "4.11.1", + "type": "boolean" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "The ID of the network to restart.", + "length": 255, + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "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 key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Lists all hypervisor capabilities.", + "isasync": false, + "name": "listHypervisorCapabilities", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "name of the snapshot", - "name": "name", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "ID of the hypervisor capability", + "length": 255, + "name": "id", + "related": "listHypervisorCapabilities", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the hypervisor capabilities row", + "name": "id", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the hypervisor type", + "name": "hypervisor", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "the maximum number of guest vms recommended for this hypervisor", + "name": "maxguestslimit", "type": "long" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "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", + "description": "true if storage motion is supported", + "name": "storagemotionenabled", "type": "boolean" }, { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "true if security group is supported", + "name": "securitygroupenabled", + "type": "boolean" }, + {}, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" }, - {} - ] + {}, + { + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" + } + ], + "since": "3.0.0" }, { - "description": "delete Tungsten-Fabric logical router", - "isasync": true, - "name": "deleteTungstenFabricLogicalRouter", + "description": "Delete Project roles in CloudStack", + "isasync": false, + "name": "deleteProjectRole", "params": [ { - "description": "the ID of zone", + "description": "ID of the project from where the role is to be deleted", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric logical router", + "description": "ID of the project role to be deleted", "length": 255, - "name": "logicalrouteruuid", + "name": "id", + "related": "createProjectRole,listProjectRoles,updateProjectRole", "required": true, - "type": "string" + "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" }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Get SolidFire Account ID", + "isasync": false, + "name": "getSolidFireAccountId", + "params": [ + { + "description": "CloudStack Account UUID", + "length": 255, + "name": "accountid", + "required": true, + "type": "string" + }, + { + "description": "Storage Pool UUID", + "length": 255, + "name": "storageid", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "SolidFire Account ID", + "name": "solidFireAccountId", + "type": "long" + }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { - "description": "Reset site to site vpn connection", - "isasync": true, - "name": "resetVpnConnection", + "description": "Lists role permissions", + "isasync": false, + "name": "listRolePermissions", "params": [ { - "description": "id of vpn connection", - "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", - "required": true, - "type": "uuid" - }, - { - "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", + "description": "ID of the role", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, "type": "uuid" - }, - { - "description": "an optional account for connection. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "related": "", "response": [ { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the public IP address", - "name": "publicip", + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", + "type": "string" }, + {}, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the ID of the role permission", + "name": "id", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, - {}, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the description of the role permission", + "name": "description", "type": "string" }, + {} + ], + "since": "4.9.0" + }, + { + "description": "Lists dedicated guest vlan ranges", + "isasync": false, + "name": "listDedicatedGuestVlanRanges", + "params": [ { - "description": "the owner", + "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", + "length": 255, "name": "account", + "required": false, "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the dedicated guest vlan range", + "length": 255, + "name": "guestvlanrange", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "project who will own the guest VLAN range", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "list dedicated guest vlan ranges by id", + "length": 255, + "name": "id", + "related": "dedicateGuestVlanRange,listDedicatedGuestVlanRanges", + "required": false, + "type": "uuid" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" + "description": "physical network id of the guest VLAN range", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "zone of the guest VLAN range", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "dedicateGuestVlanRange", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the project id of the guest vlan range", + "name": "projectid", + "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", "type": "long" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" }, + {}, { - "description": "the project id", - "name": "projectid", + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the connection ID", + "description": "the ID of the guest VLAN range", "name": "id", "type": "string" - } - ] - }, - { - "description": "migrates resources from one secondary storage to destination image store", - "isasync": true, - "name": "migrateResourceToAnotherSecondaryStorage", - "params": [ - { - "description": "id of the destination secondary storage pool to which the resources are to be migrated", - "length": 255, - "name": "destpool", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" - }, - { - "description": "id of the image store from where the data is to be migrated", - "length": 255, - "name": "srcpool", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" - }, - { - "description": "id(s) of the templates to be migrated", - "length": 255, - "name": "templates", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "type": "list" }, { - "description": "id(s) of the snapshots to be migrated", - "length": 255, - "name": "snapshots", - "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", - "required": false, - "type": "list" - } - ], - "related": "migrateSecondaryStorageData", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID of the guest VLAN range", + "name": "domainid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" }, { - "description": "Response message from migration of secondary storage data objects", - "name": "message", + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" }, - {}, { - "description": "Type of migration requested for", - "name": "migrationtype", + "description": "the project name of the guest vlan range", + "name": "project", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} - ], - "since": "4.19.0" + "description": "the zone of the guest vlan range", + "name": "zoneid", + "type": "long" + } + ] }, { - "description": "Lists Kubernetes clusters", + "description": "Lists all network ACL items", "isasync": false, - "name": "listKubernetesClusters", + "name": "listNetworkACLs", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "list network ACL items by ACL ID", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, "type": "uuid" }, { - "description": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "name", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { "description": "list only resources belonging to the domain specified", "length": 255, "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "related": "createDomain,listDomainChildren,listDomains,listDomains,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.", + "description": "list network ACL items by action", "length": 255, - "name": "listall", + "name": "action", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "clustertype", + "name": "account", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "state of the Kubernetes cluster", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "state", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { "description": "List by keyword", @@ -31308,465 +29505,409 @@ var preCache = `{ "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list network ACL items by traffic type - ingress or egress", "length": 255, - "name": "isrecursive", + "name": "traffictype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Lists network ACL Item with the specified ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", "required": false, "type": "uuid" - } - ], - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", - "response": [ - { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", - "type": "string" - }, - { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" - }, - { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", - "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", - "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" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" + "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 ID of the network of the Kubernetes cluster", + "description": "list network ACL items by network ID", + "length": 255, "name": "networkid", - "type": "string" - }, - { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "list network ACL items by protocol", + "length": 255, + "name": "protocol", + "required": false, "type": "string" - }, + } + ], + "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", + "response": [ { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" - }, - {}, - { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", - "type": "string" + "description": "the list of resource tags associated with the network ACLs", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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" + } + ], + "type": "list" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "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 master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" - }, - { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "type": "string" - }, - { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" - }, - { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, + {}, { - "description": "keypair details", - "name": "keypair", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" - }, - { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" - }, - { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + {}, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" } ] }, { - "description": "Deletes a keypair by name", - "isasync": false, - "name": "deleteSSHKeyPair", + "description": "Copies a template from one zone to another.", + "isasync": true, + "name": "copyTemplate", "params": [ { - "description": "the account associated with the keypair. Must be used with the domainId parameter.", + "description": "ID of the zone the template is being copied to.", "length": 255, - "name": "account", + "name": "destzoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Name of the keypair", + "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": "name", - "required": true, - "type": "string" + "name": "sourcezoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the project associated with keypair", + "description": "Template ID.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, + "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 domain ID associated with the keypair", + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "destzoneids", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "uuid" + "type": "list" } ], + "related": "prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" - } - ] - }, - { - "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", - "isasync": true, - "name": "createAutoScaleVmGroup", - "params": [ + }, { - "description": "the frequency in which the performance counters to be collected", - "length": 255, - "name": "interval", - "required": false, - "type": "integer" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "list of scaledown autoscale policies", - "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "list" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "list of scaleup autoscale policies", - "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "list" + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "length": 255, - "name": "maxmembers", - "required": true, - "type": "integer" + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "an optional field, whether to the display the group to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the name of the autoscale vmgroup", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "length": 255, - "name": "minmembers", - "required": true, - "type": "integer" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", - "required": true, - "type": "uuid" - } - ], - "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "response": [ + "description": "the status of the template", + "name": "status", + "type": "string" + }, { - "description": "is group for display to the regular user", - "name": "fordisplay", + "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 public port", - "name": "publicport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, + {}, { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, + {}, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, - {}, { - "description": "the public ip address", - "name": "publicip", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account owning the vm group", - "name": "account", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" - }, - { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the domain ID of the vm group", - "name": "domainid", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { "description": "true if the entity/resource has annotations", @@ -31774,763 +29915,777 @@ var preCache = `{ "type": "boolean" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the project name of the vm group", - "name": "project", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, - {} - ] - }, - { - "description": "Searches LDAP based on the username attribute", - "isasync": false, - "name": "searchLdap", - "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, + {}, { - "description": "query to search using", - "length": 255, - "name": "query", - "related": "searchLdap,listLdapUsers", - "required": true, + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "listLdapUsers", - "response": [ + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { - "description": "The user's domain", - "name": "domain", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "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 email", - "name": "email", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "The user's firstname", - "name": "firstname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "The user's principle", - "name": "principal", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "The user's lastname", - "name": "lastname", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "The user's username", - "name": "username", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Returns the status of CloudStack, whether a shutdown has been triggered and if ready to shutdown", - "isasync": false, - "name": "readyForShutdown", - "params": [ - { - "description": "the uuid of the management server", - "length": 255, - "name": "managementserverid", - "related": "listManagementServers", - "required": false, - "type": "uuid" - } - ], - "related": "prepareForShutdown,triggerShutdown", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, - {}, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, - {}, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" - } - ], - "since": "4.19.0" - }, - { - "description": "add a baremetal ping pxe server", - "isasync": true, - "name": "addBaremetalPxePingServer", - "params": [ - { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "password", - "required": true, - "type": "string" }, { - "description": "URL of the external pxe device", - "length": 255, + "description": "the URL which the template/iso is registered from", "name": "url", - "required": true, - "type": "string" - }, - { - "description": "Root directory on PING storage server", - "length": 255, - "name": "pingdir", - "required": true, "type": "string" }, { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "username", - "required": true, + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, - "type": "uuid" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "PING storage server ip", - "length": 255, - "name": "pingstorageserverip", - "required": true, + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "Username of PING storage server", - "length": 255, - "name": "pingcifsusername", - "required": false, - "type": "string" - }, + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + } + ] + }, + { + "description": "lists network that are using a nicira nvp device", + "isasync": false, + "name": "listNiciraNvpDeviceNetworks", + "params": [ { - "description": "type of pxe device", + "description": "nicira nvp device ID", "length": 255, - "name": "pxeservertype", + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Tftp root directory of PXE server", + "description": "", "length": 255, - "name": "tftpdir", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Pod Id", + "description": "", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Password of PING storage server", + "description": "List by keyword", "length": 255, - "name": "pingcifspassword", + "name": "keyword", "required": false, "type": "string" } ], - "related": "", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "url", - "name": "url", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", + "description": "the physical network id", "name": "physicalnetworkid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the network", + "name": "name", + "type": "string" }, { - "description": "PING storage server ip", - "name": "pingstorageserverip", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, - {}, { - "description": "device id of ", - "name": "id", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, - {}, { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "Root directory on PING storage server", - "name": "pingdir", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" - } - ] - }, - { - "description": "Deletes a load balancer rule.", - "isasync": true, - "name": "deleteLoadBalancerRule", - "params": [ + }, { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, - {} - ] - }, - { - "description": "create Tungsten-Fabric logical router", - "isasync": true, - "name": "createTungstenFabricLogicalRouter", - "params": [ { - "description": "Tungsten-Fabric logical router name", - "length": 255, - "name": "name", - "required": true, + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "addTungstenFabricNetworkGatewayToLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", - "response": [ + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, {}, { - "description": "Tungsten-Fabric logical router name", - "name": "name", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "AS NUMBER", + "name": "asnumber", "type": "long" }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "create Tungsten-Fabric firewall", - "isasync": true, - "name": "createTungstenFabricFirewallRule", - "params": [ - { - "description": "Tungsten-Fabric firewall rule destination tag uuid", - "length": 255, - "name": "desttaguuid", - "required": false, + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination address group uuid", - "length": 255, - "name": "destaddressgroupuuid", - "required": false, + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule direction", - "length": 255, - "name": "direction", - "required": true, + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", - "length": 255, - "name": "firewallpolicyuuid", - "required": true, + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the uuid of Tungsten-Fabric source network", - "length": 255, - "name": "srcnetworkuuid", - "required": false, + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", - "length": 255, - "name": "action", - "required": true, + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source tag uuid", - "length": 255, - "name": "srctaguuid", - "required": false, + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the uuid of Tungsten-Fabric destination network", - "length": 255, - "name": "destnetworkuuid", - "required": false, + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", - "length": 255, - "name": "name", - "required": true, + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule tag type uuid", - "length": 255, - "name": "tagtypeuuid", - "required": false, + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the sequence of Tungsten-Fabric firewall rule", - "length": 255, - "name": "sequence", - "required": true, - "type": "integer" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "Tungsten-Fabric firewall rule source address group uuid", - "length": 255, - "name": "srcaddressgroupuuid", - "required": false, + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule service group uuid", - "length": 255, - "name": "servicegroupuuid", - "required": true, + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" - } - ], - "related": "listTungstenFabricFirewallRule", - "response": [ + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source tag", - "name": "srctag", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", - "type": "string" + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "Tungsten-Fabric firewall rule uuid", - "name": "uuid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination network", - "name": "destnetwork", + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source address group", - "name": "srcaddressgroup", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, - {}, { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" - } - ] - }, - { - "description": "list portable IP ranges", - "isasync": false, - "name": "listPortableIpRanges", - "params": [ + }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "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" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "Id of the portable ip range", - "length": 255, + "description": "the id of the network", "name": "id", - "related": "createPortableIpRange,listPortableIpRanges", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Id of a Region", - "length": 255, - "name": "regionid", - "required": false, - "type": "integer" - } - ], - "related": "createPortableIpRange", - "response": [ + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + {}, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the start ip of the portable IP range", - "name": "startip", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "portable IP range ID", - "name": "id", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, - {}, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the end ip of the portable IP range", - "name": "endip", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", - "name": "portableipaddress", - "response": [ - { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", - "type": "string" - }, - { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" - }, - { - "description": "VPC the ip belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "public IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", - "name": "state", - "type": "string" - } - ], - "type": "list" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" } ] }, { - "description": "Returns user data associated with the VM", - "isasync": false, - "name": "getVirtualMachineUserData", + "description": " delete a BigSwitch BCF Controller device", + "isasync": true, + "name": "deleteBigSwitchBcfDevice", "params": [ { - "description": "The ID of the virtual machine", + "description": "BigSwitch device ID", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "bcfdeviceid", + "related": "listBigSwitchBcfDevices", "required": true, "type": "uuid" } ], - "related": "", "response": [ { - "description": "Base 64 encoded VM user data", - "name": "userdata", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -32539,11 +30694,6 @@ var preCache = `{ "type": "string" }, {}, - { - "description": "the ID of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", @@ -32551,331 +30701,385 @@ var preCache = `{ "type": "integer" } ], - "since": "4.4" + "since": "4.6.0" }, { - "description": "Updates network permissions.", + "description": "Lists all available ovs elements.", "isasync": false, - "name": "createNetworkPermissions", + "name": "listOvsElements", "params": [ { - "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "List by keyword", "length": 255, - "name": "accountids", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "keyword", "required": false, - "type": "list" + "type": "string" }, { - "description": "the network ID", + "description": "list ovs elements by network service provider id", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "required": false, "type": "uuid" }, { - "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "", "length": 255, - "name": "accounts", + "name": "page", "required": false, - "type": "list" + "type": "integer" }, { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "list ovs elements by id", "length": 255, - "name": "projectids", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "listOvsElements,configureOvsElement", "required": false, - "type": "list" + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list network offerings by enabled state", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" } ], + "related": "configureOvsElement", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" + }, + { + "description": "the id of the ovs", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the provider", + "name": "domain", "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", + "description": "Enabled/Disabled the service provider", + "name": "enabled", "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ], - "since": "4.17.0" - }, - { - "description": "Lists all configurations.", - "isasync": false, - "name": "listConfigurations", - "params": [ - { - "description": "the ID of the Domain to update the parameter value for corresponding domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, + {}, { - "description": "lists configuration by subgroup name (primarily used for UI)", - "length": 255, - "name": "subgroup", - "required": false, - "since": "4.18.0", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "description": "lists configurations by category", - "length": 255, - "name": "category", - "required": false, + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", - "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": false, - "type": "uuid" - }, + "description": "the account associated with the provider", + "name": "account", + "type": "string" + } + ] + }, + { + "description": "associate a profile to a blade", + "isasync": true, + "name": "associateUcsProfileToBlade", + "params": [ { - "description": "lists configuration by parent name (primarily used for UI)", + "description": "profile dn", "length": 255, - "name": "parent", - "required": false, - "since": "4.18.0", + "name": "profiledn", + "required": true, "type": "string" }, { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", + "description": "ucs manager id", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", + "required": true, "type": "uuid" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "blade id", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, + "name": "bladeid", + "related": "associateUcsProfileToBlade", + "required": true, "type": "uuid" - }, + } + ], + "related": "", + "response": [ { - "description": "lists configuration by name", - "length": 255, - "name": "name", - "required": false, + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "ucs blade id", + "name": "id", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "lists configuration by group name (primarily used for UI)", - "length": 255, - "name": "group", - "required": false, - "since": "4.18.0", + "description": "ucs blade dn", + "name": "bladedn", "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "updateConfiguration", - "response": [ + "description": "ucs manager id", + "name": "ucsmanagerid", + "type": "string" + }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "cloudstack host id this blade associates to", + "name": "hostid", "type": "string" }, {}, { - "description": "the type of the configuration value", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Checks the 2FA code for the user.", + "isasync": false, + "name": "validateUserTwoFactorAuthenticationCode", + "params": [ { - "description": "the category of the configuration", - "name": "category", + "description": "two factor authentication code", + "length": 255, + "name": "codefor2fa", + "required": true, "type": "string" + } + ], + "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 default value of the configuration", - "name": "defaultvalue", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.18.0" + }, + { + "description": "Updates a VMware datacenter details for a zone", + "isasync": false, + "name": "updateVmwareDc", + "params": [ { - "description": "the name of the configuration", - "name": "name", + "description": "The password for specified username.", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "the group of the configuration", - "name": "group", + "description": "The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "length": 255, + "name": "vcenter", + "required": false, "type": "string" }, { - "description": "the component of the configuration", - "name": "component", - "type": "string" + "description": "The zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the description of the configuration", - "name": "description", + "description": "VMware datacenter name.", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the possible options of the configuration value", - "name": "options", - "type": "string" + "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the value of the configuration", - "name": "id", - "type": "long" + "description": "The username required to connect to resource.", + "length": 255, + "name": "username", + "required": false, + "type": "string" + } + ], + "related": "addVmwareDc,listVmwareDcs", + "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", + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, {}, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "The VMware vCenter name/ip", + "name": "vcenter", "type": "string" }, + {}, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the value of the configuration", - "name": "value", - "type": "string" + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" } - ] + ], + "since": "4.12.0" }, { - "description": "Disables static rule for given IP address", - "isasync": true, - "name": "disableStaticNat", + "description": "Starts a router.", + "isasync": false, + "name": "getRouterHealthCheckResults", "params": [ { - "description": "the public IP address ID for which static NAT feature is being disabled", + "description": "the ID of the router", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "routerid", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "required": true, "type": "uuid" + }, + { + "description": "if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched", + "length": 255, + "name": "performfreshchecks", + "required": false, + "type": "boolean" } ], + "related": "", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the id of the router", + "name": "healthchecks", + "type": "list" }, {}, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the router", + "name": "routerid", "type": "string" } - ] + ], + "since": "4.14.0" }, { - "description": "Assigns secondary IP to NIC", - "isasync": true, - "name": "addIpToNic", + "description": "list control center", + "isasync": false, + "name": "listNetscalerControlCenter", "params": [ { - "description": "the ID of the nic to which you want to assign private IP", + "description": "", "length": 255, - "name": "nicid", - "related": "listNics", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Secondary IP Address", + "description": "", "length": 255, - "name": "ipaddress", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" } @@ -32883,23 +31087,13 @@ var preCache = `{ "related": "", "response": [ { - "description": "the ID of the secondary private IP addr", - "name": "id", - "type": "string" - }, - { - "description": "Secondary IP address", + "description": "ncc_ip", "name": "ipaddress", "type": "string" }, { - "description": "the list of Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "nicid", + "description": "username", + "name": "username", "type": "string" }, {}, @@ -32908,1156 +31102,878 @@ var preCache = `{ "name": "jobid", "type": "string" }, + {}, { - "description": "the ID of the network", - "name": "networkid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "num_retries", + "name": "numretries", "type": "string" }, { - "description": "the ID of the vm", - "name": "virtualmachineid", + "description": "uuid", + "name": "uuid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id", + "name": "id", + "type": "string" } ] }, { - "description": "Scales a created, running or stopped CloudManaged Kubernetes cluster", + "description": "Resizes a volume", "isasync": true, - "name": "scaleKubernetesCluster", + "name": "resizeVolume", "params": [ { - "description": "Whether autoscaling is enabled for the cluster", + "description": "Flag to allow automatic migration of the volume to another suitable storage pool that accommodates the new size", "length": 255, - "name": "autoscalingenabled", + "name": "automigrate", "required": false, + "since": "4.20.1", "type": "boolean" }, { - "description": "Minimum number of worker nodes in the cluster", + "description": "new disk offering id", "length": 255, - "name": "minsize", + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "the ID of the Kubernetes cluster", + "description": "New minimum number of IOPS", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" + "name": "miniops", + "required": false, + "type": "long" }, { - "description": "the IDs of the nodes to be removed", + "description": "New volume size in GB", "length": 255, - "name": "nodeids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "size", "required": false, - "type": "list" + "type": "long" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "Verify OK to Shrink", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "shrinkok", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "number of Kubernetes cluster nodes", + "description": "the ID of the disk volume", "length": 255, - "name": "size", - "required": false, - "type": "long" + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" }, { - "description": "Maximum number of worker nodes in the cluster", + "description": "New maximum number of IOPS", "length": 255, - "name": "maxsize", + "name": "maxiops", "required": false, "type": "long" } ], - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the state of the Kubernetes cluster", + "description": "the state of the disk volume", "name": "state", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" - }, - { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the Kubernetes cluster", - "name": "name", - "type": "string" - }, - { - "description": "Public IP Address of the cluster", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the id of the Kubernetes cluster", + "description": "ID of the disk volume", "name": "id", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" - }, - { - "description": "keypair details", - "name": "keypair", - "type": "string" - }, - { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" - }, - { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, - {}, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" - }, - { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" - }, - { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" - }, - { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", - "type": "string" - } - ] - }, - { - "description": "Stops a NetScalervm.", - "isasync": true, - "name": "stopNetScalerVpx", - "params": [ - { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the ID of the NetScaler vm", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, - "type": "uuid" - } - ], - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "response": [ - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the domain ID associated with the router", + "description": "the ID of the domain associated with the disk volume", "name": "domainid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, - {}, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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 date and time the router was created", - "name": "created", - "type": "date" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - } - ], - "type": "list" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the account associated with the router", - "name": "account", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, + {}, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" } ] }, { - "description": "Delete a Ucs manager", - "isasync": false, - "name": "deleteUcsManager", + "description": "Deletes affinity group", + "isasync": true, + "name": "deleteAffinityGroup", "params": [ { - "description": "ucs manager id", + "description": "the domain ID of account owning the affinity group", "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} - ] - }, - { - "description": "Deletes a host.", - "isasync": false, - "name": "deleteHost", - "params": [ { - "description": "the host ID", + "description": "The ID of the affinity group. Mutually exclusive with name parameter", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, + "related": "createAffinityGroup,listAffinityGroups", + "required": false, "type": "uuid" }, { - "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", + "description": "The name of the affinity group. Mutually exclusive with ID parameter", "length": 255, - "name": "forcedestroylocalstorage", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped", + "description": "the project of the affinity group", "length": 255, - "name": "forced", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "the account of the affinity group. Must be specified with domain ID", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] }, { - "description": "Deletes a vm group", + "description": "Deletes a network offering.", "isasync": false, - "name": "deleteInstanceGroup", + "name": "deleteNetworkOffering", "params": [ { - "description": "the ID of the instance group", + "description": "the ID of the network offering", "length": 255, "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "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": "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" + } + ], + "since": "3.0.0" }, { - "description": "deletes the resource icon from the specified resource(s)", - "isasync": false, - "name": "deleteResourceIcon", + "description": "Dedicates a Pod.", + "isasync": true, + "name": "dedicatePod", "params": [ { - "description": "list of resources to upload the icon/image for", + "description": "the ID of the Pod", "length": 255, - "name": "resourceids", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": true, - "type": "list" + "type": "uuid" }, { - "description": "type of the resource", + "description": "the ID of the containing domain", "length": 255, - "name": "resourcetype", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": true, + "type": "uuid" + }, + { + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" } ], + "related": "listDedicatedPods", "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "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": "Lists capabilities", - "isasync": false, - "name": "listCapabilities", - "params": [], - "related": "", - "response": [ - { - "description": "If invitation confirmation is required when add account to project", - "name": "projectinviterequired", - "type": "boolean" - }, - { - "description": "true if region wide secondary is enabled, false otherwise", - "name": "regionsecondaryenabled", - "type": "boolean" - }, - { - "description": "true if user and domain admins can set templates to be shared, false otherwise", - "name": "userpublictemplateenabled", - "type": "boolean" }, { - "description": "minimum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingminsize", - "type": "long" - }, - { - "description": "version of the cloud stack", - "name": "cloudstackversion", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the user can recover and expunge virtualmachines, false otherwise", - "name": "allowuserexpungerecovervm", - "type": "boolean" + "description": "the ID of the Pod", + "name": "podid", + "type": "string" }, { - "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", - "name": "kubernetesclusterexperimentalfeaturesenabled", - "type": "boolean" + "description": "the Name of the Pod", + "name": "podname", + "type": "string" }, { - "description": "true if stats are collected only for user instances, false if system instance stats are also collected", - "name": "instancesstatsuseronly", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if regular user is allowed to create projects", - "name": "allowusercreateprojects", - "type": "boolean" - }, + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" + } + ] + }, + { + "description": "Update a Storage network IP range, only allowed when no IPs in this range have been allocated.", + "isasync": true, + "name": "updateStorageNetworkIpRange", + "params": [ { - "description": "true if stats are retained for instance disks otherwise false", - "name": "instancesdisksstatsretentionenabled", - "type": "boolean" + "description": "the beginning IP address", + "length": 255, + "name": "startip", + "required": false, + "type": "string" }, { - "description": "the retention time for Instances stats", - "name": "instancesstatsretentiontime", - "type": "integer" + "description": "the ending IP address", + "length": 255, + "name": "endip", + "required": false, + "type": "string" }, { - "description": "Max allowed number of api requests within the specified interval", - "name": "apilimitmax", + "description": "Optional. the vlan the ip range sits on", + "length": 255, + "name": "vlan", + "required": false, "type": "integer" }, { - "description": "default page size in the UI for various views, value set in the configurations", - "name": "defaultuipagesize", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the netmask for storage network", + "length": 255, + "name": "netmask", + "required": false, "type": "string" }, { - "description": "true if dynamic role-based api checker is enabled, false otherwise", - "name": "dynamicrolesenabled", - "type": "boolean" - }, + "description": "UUID of storage network ip range", + "length": 255, + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", + "required": true, + "type": "uuid" + } + ], + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "response": [ { - "description": "the retention time for Instances disks stats", - "name": "instancesdisksstatsretentiontime", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "true if snapshot is supported for KVM host, false otherwise", - "name": "kvmsnapshotenabled", - "type": "boolean" + "description": "the netmask of the storage network IP range", + "name": "netmask", + "type": "string" }, + {}, { - "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", - "name": "allowuserviewdestroyedvm", - "type": "boolean" + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", + "type": "string" }, { - "description": "time interval (in seconds) to reset api count", - "name": "apilimitinterval", - "type": "integer" + "description": "the uuid of storage network IP range.", + "name": "id", + "type": "string" }, { - "description": "true if region supports elastic load balancer on basic zones", - "name": "supportELB", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, { - "description": "true if Kubernetes Service plugin is enabled, false otherwise", - "name": "kubernetesserviceenabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "maximum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingmaxsize", - "type": "long" + "description": "the start ip of the storage network IP range", + "name": "startip", + "type": "string" }, - {}, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" }, { - "description": "Display name for custom hypervisor", - "name": "customhypervisordisplayname", + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" }, { - "description": "true if the user can recover and expunge volumes, false otherwise", - "name": "allowuserexpungerecovervolume", - "type": "boolean" + "description": "the end ip of the storage network IP range", + "name": "endip", + "type": "string" }, { - "description": "true if users can see all accounts within the same domain, false otherwise", - "name": "allowuserviewalldomainaccounts", - "type": "boolean" + "description": "the gateway of the storage network IP range", + "name": "gateway", + "type": "string" }, {} - ] + ], + "since": "3.0.0" }, { - "description": "Updates traffic type of a physical network", - "isasync": true, - "name": "updateTrafficType", + "description": "Creates a GPU card definition in the system", + "isasync": false, + "name": "createGpuCard", "params": [ { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "description": "the display name of the GPU card", "length": 255, - "name": "hypervnetworklabel", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "the device name of the GPU card", "length": 255, - "name": "kvmnetworklabel", - "required": false, + "name": "devicename", + "required": true, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "description": "the device ID of the GPU card", "length": 255, - "name": "vmwarenetworklabel", - "required": false, + "name": "deviceid", + "required": true, "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "description": "the video RAM size in MB for the passthrough vGPU profile", "length": 255, - "name": "ovm3networklabel", + "name": "videoram", "required": false, - "type": "string" + "type": "long" }, { - "description": "traffic type id", + "description": "the vendor ID of the GPU card", "length": 255, - "name": "id", - "related": "addTrafficType,updateTrafficType", + "name": "vendorid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "the vendor name of the GPU card", "length": 255, - "name": "xennetworklabel", - "required": false, + "name": "vendorname", + "required": true, "type": "string" } ], - "related": "addTrafficType", + "related": "updateGpuCard,listGpuCards", "response": [ + {}, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "the ID of the GPU card", + "name": "id", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", + "description": "the vendor name of the GPU card", + "name": "vendorname", "type": "string" }, + {}, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "the device name of the GPU card", + "name": "devicename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the device ID of the GPU card", + "name": "deviceid", "type": "string" }, { @@ -34066,50 +31982,40 @@ var preCache = `{ "type": "integer" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", - "type": "string" - }, - { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", - "type": "string" - }, - {}, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the display name of the GPU card", + "name": "name", "type": "string" }, { - "description": "id of the network provider", - "name": "id", + "description": "the vendor ID of the GPU card", + "name": "vendorid", "type": "string" - }, - {} + } ], - "since": "3.0.0" + "since": "4.21.0" }, { - "description": "Release dedication of zone", - "isasync": true, - "name": "releaseDedicatedZone", + "description": "Synchronize Tungsten-Fabric data", + "isasync": false, + "name": "synchronizeTungstenFabricData", "params": [ { - "description": "the ID of the Zone", + "description": "provider id", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "createTungstenFabricProvider,listTungstenFabricProviders", "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", @@ -34120,94 +32026,106 @@ var preCache = `{ "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": "List Conditions for VM auto scaling", - "isasync": false, - "name": "listConditions", + "description": "Purge expunged resources", + "isasync": true, + "name": "purgeExpungedResources", "params": [ { - "description": "", + "description": "The start date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", "length": 255, - "name": "pagesize", + "name": "startdate", "required": false, - "type": "integer" + "type": "date" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The type of the resource which need to be purged. Supported types: VirtualMachine", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "resourcetype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "The end date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", "length": 255, - "name": "keyword", + "name": "enddate", "required": false, - "type": "string" + "type": "date" }, { - "description": "ID of the Condition.", + "description": "The size of batch used during purging", "length": 255, - "name": "id", - "related": "createCondition,listConditions", + "name": "batchsize", "required": false, - "type": "uuid" + "type": "long" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "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, + "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" }, + {} + ], + "since": "4.20" + }, + { + "description": "Lists all available vGPU profiles", + "isasync": false, + "name": "listVgpuProfiles", + "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "name of the vGPU profile", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, { - "description": "Counter-id of the condition.", + "description": "ID of the vGPU profile", "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", + "name": "id", + "related": "createVgpuProfile,updateVgpuProfile,listVgpuProfiles", "required": false, "type": "uuid" }, { - "description": "the ID of the policy", + "description": "", "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "If true, only vGPU profiles which have a device will be listed. If false, all vGPU profiles will be listed.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "activeonly", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", @@ -34215,555 +32133,505 @@ var preCache = `{ "name": "page", "required": false, "type": "integer" - } - ], - "related": "createCondition", - "response": [ - { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" - }, - {}, - { - "description": "the Id of the Counter.", - "name": "counterid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the Name of the Counter.", - "name": "countername", - "type": "string" + "description": "the GPU card ID associated with this GPU device", + "length": 255, + "name": "gpucardid", + "related": "updateGpuCard,listGpuCards", + "required": false, + "type": "uuid" }, { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, - {}, + } + ], + "related": "createVgpuProfile,updateVgpuProfile", + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the id of the Condition", - "name": "id", - "type": "string" - }, - { - "description": "zone id of counter", - "name": "zoneid", - "type": "string" - }, - { - "description": "the owner of the Condition.", - "name": "account", + "description": "the display name of the GPU card", + "name": "name", "type": "string" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "the description of the vGPU profile", + "name": "description", "type": "string" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" - }, - { - "description": "the project name of the Condition", - "name": "project", + "description": "the vendor name of the GPU card", + "name": "vendorname", "type": "string" }, { - "description": "the domain name of the owner.", - "name": "domain", + "description": "the device name of the GPU card", + "name": "devicename", "type": "string" }, { - "description": "the project id of the Condition.", - "name": "projectid", + "description": "the vendor ID of the GPU card", + "name": "vendorid", "type": "string" - } - ] - }, - { - "description": "Updates a network serviceProvider of a physical network", - "isasync": true, - "name": "updateNetworkServiceProvider", - "params": [ - { - "description": "the list of services to be enabled for this physical network service provider", - "length": 255, - "name": "servicelist", - "required": false, - "type": "list" }, { - "description": "Enabled/Disabled/Shutdown the physical network service provider", - "length": 255, - "name": "state", - "required": false, - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, + {}, { - "description": "network service provider id", - "length": 255, - "name": "id", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", - "required": true, - "type": "uuid" - } - ], - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the provider name", - "name": "name", + "description": "the ID of the GPU card associated with this vGPU profile", + "name": "gpucardid", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the name of the vGPU profile", + "name": "gpucardname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the maximum number of vGPUs per physical GPU", + "name": "maxvgpuperphysicalgpu", + "type": "long" }, { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "uuid of the network provider", + "description": "the ID of the GPU card", "name": "id", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the device ID of the GPU card", + "name": "deviceid", + "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, - {} + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + } ], - "since": "3.0.0" + "since": "4.21.0" }, { - "description": "Lists Management Server metrics", - "isasync": false, - "name": "listManagementServersMetrics", + "description": "Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering", + "isasync": true, + "name": "changeOfferingForVolume", "params": [ { - "description": "", + "description": "the ID of the volume", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" }, { - "description": "the id of the management server", + "description": "Verify OK to Shrink", "length": 255, - "name": "id", - "related": "listManagementServers", + "name": "shrinkok", "required": false, + "type": "boolean" + }, + { + "description": "new disk offering id", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": true, "type": "uuid" }, { - "description": "", + "description": "New maximum number of IOPS for the custom disk offering", "length": 255, - "name": "pagesize", + "name": "maxiops", "required": false, - "type": "integer" + "type": "long" }, { - "description": "include system level stats", + "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", "length": 255, - "name": "system", - "related": "listManagementServersMetrics", + "name": "automigrate", "required": false, "type": "boolean" }, { - "description": "List by keyword", + "description": "New volume size in GB for the custom disk offering", "length": 255, - "name": "keyword", + "name": "size", "required": false, - "type": "string" + "type": "long" }, { - "description": "the name of the management server", + "description": "New minimum number of IOPS for the custom disk offering", "length": 255, - "name": "name", + "name": "miniops", "required": false, - "type": "string" + "type": "long" } ], - "related": "", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "the load averages for 1 5 and 15 minutes", - "name": "systemloadaverages", - "type": "double[]" - }, - { - "description": "Total system memory", - "name": "systemmemorytotal", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "The number of daemon threads", - "name": "threadsdaemoncount", - "type": "integer" - }, - { - "description": "the system has a usage server running locally", - "name": "usageislocal", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", - "type": "string" - }, - { - "description": "the number of processors available to the JVM", - "name": "availableprocessors", - "type": "integer" - }, - {}, - { - "description": "Free system memory", - "name": "systemmemoryfree", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the management server", - "name": "id", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the IP Address for this Management Server", - "name": "serviceip", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the amount of memory used by this Management Server", - "name": "heapmemoryused", - "type": "long" - }, - { - "description": "the total system cpu capacity", - "name": "systemtotalcpucycles", - "type": "double" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the version of the management server", - "name": "version", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the number of client sessions active on this Management Server", - "name": "sessions", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "The number of threads", - "name": "threadstotalcount", - "type": "integer" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the current cpu load", - "name": "cpuload", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the system load for user, and system processes and the system idle cycles", - "name": "systemcycleusage", - "type": "long[]" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the last time this Management Server was started", - "name": "lastserverstart", - "type": "date" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "the amount of memory allocated to this Management Server", - "name": "heapmemorytotal", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "The number of waiting threads", - "name": "threadswaitingcount", - "type": "integer" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "the system is running against a local database", - "name": "dbislocal", - "type": "boolean" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "The number of blocked threads", - "name": "threadsblockedcount", - "type": "integer" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "the log files and their usage on disk", - "name": "loginfo", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the name of the management server", - "name": "name", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the number of agents this Management Server is responsible for", - "name": "agentcount", - "type": "integer" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "The number of terminated threads", - "name": "threadsteminatedcount", - "type": "integer" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "The number of runnable threads", - "name": "threadsrunnablecount", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Amount of memory used", - "name": "systemmemoryused", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "Virtual size of the fully loaded process", - "name": "systemmemoryvirtualsize", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" + "description": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" - } - ], - "since": "4.17.0" - }, - { - "description": "Removes a virtual machine or a list of virtual machines from a load balancer rule.", - "isasync": true, - "name": "removeFromLoadBalancerRule", - "params": [ - { - "description": "the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)", - "length": 255, - "name": "virtualmachineids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "list" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "The ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", - "length": 255, - "name": "vmidipmap", - "required": false, - "since": "4.4", - "type": "map" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, - {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Lists vm groups", - "isasync": false, - "name": "listInstanceGroups", - "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "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": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "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": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "list instance groups by ID", - "length": 255, - "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", - "required": false, - "type": "uuid" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the 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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "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, + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "list instance groups by name", - "length": 255, - "name": "name", - "required": false, + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "createInstanceGroup,updateInstanceGroup", - "response": [ + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the instance group", - "name": "id", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "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": "pod name of the volume", + "name": "podname", "type": "string" }, { @@ -34772,170 +32640,376 @@ var preCache = `{ "type": "boolean" }, { - "description": "time and date the instance group was created", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the date the disk volume was created", "name": "created", "type": "date" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the instance group", - "name": "name", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the project name of the instance group", - "name": "project", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, {}, { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + } + ], + "since": "4.17" + }, + { + "description": "Remove an Ldap Configuration", + "isasync": false, + "name": "deleteLdapConfiguration", + "params": [ + { + "description": "linked domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "port", + "length": 255, + "name": "port", + "required": false, + "type": "integer" + }, + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" + } + ], + "related": "addLdapConfiguration,listLdapConfigurations", + "response": [ + { + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "linked domain", + "name": "domainid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "port the ldap server is running on", + "name": "port", + "type": "int" } - ] + ], + "since": "4.2.0" }, { - "description": "migrates data objects from one secondary storage to destination image store(s)", - "isasync": true, - "name": "migrateSecondaryStorageData", + "description": "Creates a Project role", + "isasync": false, + "name": "createProjectRole", "params": [ { - "description": "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated", + "description": "creates a project role with this unique name", "length": 255, - "name": "destpools", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "name": "name", "required": true, - "type": "list" + "type": "string" }, { - "description": "id of the image store from where the data is to be migrated", + "description": "The description of the Project role", "length": 255, - "name": "srcpool", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" + "name": "description", + "required": false, + "type": "string" }, { - "description": "Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete", + "description": "ID of project where role is being created", "length": 255, - "name": "migrationtype", - "required": false, - "type": "string" + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "listProjectRoles,updateProjectRole", "response": [ { - "description": "Type of migration requested for", - "name": "migrationtype", + "description": "the name of the role", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the project", + "name": "projectid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the description of the role", + "name": "description", + "type": "string" + }, + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", "type": "boolean" }, - {}, { - "description": "Response message from migration of secondary storage data objects", - "name": "message", + "description": "the ID of the role", + "name": "id", + "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.15.0" }, { - "description": "Creates a static route", + "description": "Creates an Ipv6 firewall rule in the given network (the network must not belong to VPC)", "isasync": true, - "name": "createStaticRoute", + "name": "createIpv6FirewallRule", "params": [ { - "description": "the gateway id we are creating static route for", + "description": "the starting port of Ipv6 firewall rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" + }, + { + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, + { + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" + }, + { + "description": "The network of the VM the Ipv6 firewall rule will be created for", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" }, { - "description": "static route cidr", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "cidr", + "name": "protocol", "required": true, "type": "string" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "type": "boolean" + }, + { + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "destcidrlist", + "required": false, + "type": "list" + }, + { + "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "length": 255, + "name": "traffictype", + "required": false, + "type": "string" } ], - "related": "listStaticRoutes", + "related": "updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", "response": [ { - "description": "the ID of the domain associated with the static route", - "name": "domainid", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the project name of the static route", - "name": "project", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the state of the static route", - "name": "state", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "static route CIDR", - "name": "cidr", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the list of resource tags associated with static route", + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ { @@ -34944,13 +33018,13 @@ var preCache = `{ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -34959,345 +33033,510 @@ var preCache = `{ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { "description": "customer associated with the tag", "name": "customer", "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" } ], "type": "list" }, { - "description": "the account associated with the static route", - "name": "account", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the project id of the static route", - "name": "projectid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, - {}, { - "description": "the ID of static route", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - { - "description": "the domain associated with the static route", - "name": "domain", - "type": "string" - } + {} ] }, { - "description": "Destroys a Volume.", - "isasync": true, - "name": "destroyVolume", + "description": "Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobs have been completed.", + "isasync": false, + "name": "triggerShutdown", "params": [ { - "description": "The ID of the volume", + "description": "the id of the management server", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "managementserverid", + "related": "listManagementServers", "required": true, "type": "uuid" + } + ], + "related": "prepareForMaintenance,cancelMaintenance,prepareForShutdown,cancelShutdown,readyForShutdown", + "response": [ + { + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", + "type": "boolean" }, { - "description": "If true is passed, the volume is expunged immediately. False by default.", - "length": 255, - "name": "expunge", - "required": false, - "since": "4.6.0", + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" + }, + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "string" + }, + { + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", + "type": "long" + }, + { + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "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": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", "type": "boolean" + }, + {}, + {}, + { + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" } ], - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "response": [ + "since": "4.19.0" + }, + { + "description": "Updates a network", + "isasync": true, + "name": "updateNetwork", + "params": [ { - "description": "name of the virtual machine", - "name": "vmname", + "description": "network domain", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "length": 255, + "name": "hideipaddressusage", + "required": false, + "type": "boolean" + }, + { + "description": "the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone", + "length": 255, + "name": "dns1", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "an optional field, whether to the display the network to the end user or not.", + "length": 255, + "name": "displaynetwork", + "required": false, + "type": "boolean" + }, + { + "description": "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", + "length": 255, + "name": "ip6dns2", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "name of the disk volume", + "description": "MTU to be configured on the network VR's public facing interfaces", + "length": 255, + "name": "publicmtu", + "required": false, + "since": "4.18.0", + "type": "integer" + }, + { + "description": "the new name for the network", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "Setting this to true will cause a forced network update,", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" }, { - "description": "the status of the volume", - "name": "status", + "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": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", + "length": 255, + "name": "dns2", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "network offering ID", + "length": 255, + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "required": false, + "type": "uuid" + }, + { + "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", + "length": 255, + "name": "guestvmcidr", + "required": false, "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network", + "length": 255, + "name": "sourcenatipaddress", + "required": false, + "since": "4.19", "type": "string" }, - {}, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider", + "length": 255, + "name": "updateinsequence", + "required": false, + "type": "boolean" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the ID of the network", + "length": 255, + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "Force update even if CIDR type is different", + "length": 255, + "name": "changecidr", + "required": false, + "type": "boolean" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the new display text for the network", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", + "length": 255, + "name": "ip6dns1", + "required": false, + "since": "4.18.0", + "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "MTU to be configured on the network VR's public facing interfaces", + "length": 255, + "name": "privatemtu", + "required": false, + "since": "4.18.0", + "type": "integer" + } + ], + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "response": [ + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, - {}, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the list of resource tags associated", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the list of resource tags associated with network", "name": "tags", "response": [ { @@ -35306,23 +33545,23 @@ var preCache = `{ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -35331,295 +33570,316 @@ var preCache = `{ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], + "type": "list" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", "type": "set" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "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": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, + {}, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - } - ], - "since": "4.14.0" - }, - { - "description": "Adds traffic type to a physical network", - "isasync": true, - "name": "addTrafficType", - "params": [ - { - "description": "The VLAN id to be used for Management traffic by VMware host", - "length": 255, - "name": "vlan", - "required": false, - "type": "string" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + } + ], + "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" + } + ], + "type": "list" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "length": 255, - "name": "ovm3networklabel", - "required": false, + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", - "length": 255, - "name": "hypervnetworklabel", - "required": false, + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.", - "length": 255, - "name": "isolationmethod", - "required": false, + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "length": 255, - "name": "xennetworklabel", - "required": false, + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "length": 255, - "name": "vmwarenetworklabel", - "required": false, + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "length": 255, - "name": "kvmnetworklabel", - "required": false, + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the trafficType to be added to the physical network", - "length": 255, - "name": "traffictype", - "required": true, - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "id of the network provider", - "name": "id", + "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 network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "the id of the network", + "name": "id", "type": "string" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" } - ], - "since": "3.0.0" + ] }, { - "description": "Deletes a Private gateway", - "isasync": true, - "name": "deletePrivateGateway", + "description": "Lists VM backups", + "isasync": false, + "name": "listBackups", "params": [ { - "description": "the ID of the private gateway", + "description": "id of the VM", "length": 255, - "name": "id", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", - "required": true, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "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": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "list backups by name", + "length": 255, + "name": "name", + "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Lists the secondary storage selectors and their rules.", - "isasync": false, - "name": "listSecondaryStorageSelectors", - "params": [ - { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Show removed heuristics.", + "description": "id of the backup", "length": 255, - "name": "showremoved", + "name": "id", + "related": "updateBackupSchedule,listBackups", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "List by keyword", @@ -35629,732 +33889,682 @@ var preCache = `{ "type": "string" }, { - "description": "", + "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": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "description": "", "length": 255, - "name": "type", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The zone ID to be used in the search filter.", + "description": "list backups by zone id", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", - "required": true, + "required": false, "type": "uuid" - } - ], - "related": "createSecondaryStorageSelector,updateSecondaryStorageSelector,removeSecondaryStorageSelector", - "response": [ - { - "description": "Name of the heuristic.", - "name": "name", - "type": "string" - }, - { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", - "type": "string" - }, - { - "description": "ID of the heuristic.", - "name": "id", - "type": "string" - }, - { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", - "type": "string" - }, - { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" - }, - { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", - "type": "string" }, { - "description": "Description of the heuristic.", - "name": "description", - "type": "string" - }, - {} - ], - "since": "4.19.0" - }, - { - "description": "List all virtual machine instances that are assigned to a load balancer rule.", - "isasync": false, - "name": "listLoadBalancerRuleInstances", - "params": [ - { - "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", + "description": "list backups by backup offering", "length": 255, - "name": "applied", + "name": "backupofferingid", + "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "uuid" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "true if load balancer rule VM IP information to be included; default is false", + "description": "list backups with VM details", "length": 255, - "name": "lbvmips", + "name": "listvmdetails", "required": false, + "since": "4.21.0", "type": "boolean" }, { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", - "required": true, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], - "related": "listLoadBalancerRuleInstances", + "related": "updateBackupSchedule", "response": [ - {}, { - "description": "the user vm set for lb rule", - "name": "loadbalancerruleinstance", - "type": "uservmresponse" + "description": "name of the VM", + "name": "virtualmachinename", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The backup offering corresponding to this backup was removed from the VM", + "name": "vmbackupofferingremoved", + "type": "boolean" }, - {}, { - "description": "IP addresses of the vm set of lb rule", - "name": "lbvmipaddresses", - "type": "list" + "description": "backup type", + "name": "type", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "account id", + "name": "accountid", "type": "string" - } - ] - }, - { - "description": "Removes a condition for VM auto scaling", - "isasync": true, - "name": "deleteCondition", - "params": [ + }, { - "description": "the ID of the condition.", - "length": 255, - "name": "id", - "related": "createCondition", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "Lists the vm specific details for the backup", + "name": "vmdetails", + "type": "map" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the VM", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the backup", + "name": "name", "type": "string" }, - {} - ] - }, - { - "description": "Updates a domain with a new name", - "isasync": false, - "name": "updateDomain", - "params": [ { - "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "backup offering name", + "name": "backupofferingname", "type": "string" }, { - "description": "ID of domain to update", - "length": 255, + "description": "ID of the VM backup", "name": "id", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, - "type": "uuid" - }, - { - "description": "updates domain with this name", - "length": 255, - "name": "name", - "required": false, "type": "string" - } - ], - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "response": [ - { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" }, {}, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "backed up volumes", + "name": "volumes", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "domain id", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "domain name", + "name": "domain", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "Interval type of the backup", + "name": "intervaltype", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "description for the backup", + "name": "description", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "account name", + "name": "account", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "zone id", + "name": "zoneid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "zone name", + "name": "zone", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "external backup id", + "name": "externalid", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "backup size in bytes", + "name": "size", + "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "backup date", + "name": "created", + "type": "date" }, - {}, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "backup status", + "name": "status", + "type": "status" }, + {}, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "backup offering id", + "name": "backupofferingid", "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "List Usage Types", + "isasync": false, + "name": "listUsageTypes", + "params": [], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", - "type": "string" + "description": "Usage type ID", + "name": "id", + "type": "integer" }, + {}, + {}, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "Usage type description", + "name": "description", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "Usage type name", + "name": "name", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Lists Backup and Recovery providers", + "isasync": false, + "name": "listBackupProviders", + "params": [ { - "description": "the path of the domain", - "name": "path", + "description": "List Backup and Recovery provider by name", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ + {}, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the description of the CA service provider", + "name": "description", + "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the CA service provider name", + "name": "name", "type": "string" }, + {} + ], + "since": "4.14.0" + }, + { + "description": "Updates an existing GUI theme.", + "isasync": false, + "name": "updateGuiTheme", + "params": [ { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "length": 65535, + "name": "jsonconfiguration", + "required": false, + "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "A description for the theme.", + "length": 4096, + "name": "description", + "required": false, "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", - "type": "string" + "description": "The ID of the theme to be updated.", + "length": 255, + "name": "id", + "related": "listGuiThemes,updateGuiTheme,createGuiTheme", + "required": true, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "length": 65535, + "name": "accountids", + "required": false, "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "length": 65535, + "name": "domainids", + "required": false, + "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", - "type": "string" + "description": "Defines whether the subdomains of the informed domains are considered. Default value is false.", + "length": 255, + "name": "recursivedomains", + "required": false, + "type": "boolean" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "length": 65535, + "name": "css", + "required": false, "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "A name to identify the theme.", + "length": 2048, + "name": "name", + "required": false, "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" - }, + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "length": 65535, + "name": "commonnames", + "required": false, + "type": "string" + } + ], + "related": "listGuiThemes,createGuiTheme", + "response": [ { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "accountids", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "ID of the custom GUI theme.", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Description of the GUI theme.", + "name": "description", + "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "Whether to consider the subdomains of the informed domain IDs.", + "name": "recursivedomains", + "type": "boolean" }, + {}, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "css", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "name": "commonnames", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "jsonconfiguration", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "domainids", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "When the GUI theme was created.", + "name": "created", + "type": "date" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", - "type": "string" + "description": "When the GUI theme was removed.", + "name": "removed", + "type": "date" }, + {}, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "Name of the GUI theme.", + "name": "name", "type": "string" - }, + } + ], + "since": "4.21.0.0" + }, + { + "description": "Deletes a VPC", + "isasync": true, + "name": "deleteVPC", + "params": [ + { + "description": "the ID of the VPC", + "length": 255, + "name": "id", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" - } + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} ] }, { - "description": "Updates a physical network", + "description": "Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool", "isasync": true, - "name": "updatePhysicalNetwork", + "name": "migrateVirtualMachine", "params": [ { - "description": "the speed for the physical network[1G/10G]", + "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", "length": 255, - "name": "networkspeed", + "name": "autoselect", "required": false, - "type": "string" + "since": "4.16.0", + "type": "boolean" }, { - "description": "the VLAN for the physical network", + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", "length": 255, - "name": "vlan", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" - }, - { - "description": "physical network id", - "length": 255, - "name": "id", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, "type": "uuid" }, { - "description": "Enabled/Disabled", + "description": "Destination Host ID to migrate VM to.", "length": 255, - "name": "state", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Tag the physical network", + "description": "the ID of the virtual machine", "length": 255, - "name": "tags", - "required": false, - "type": "list" + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" } ], - "related": "createPhysicalNetwork", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "response": [ + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "state of the physical network", + "description": "the state of the virtual machine", "name": "state", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "name of the physical network", - "name": "name", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the uuid of the physical network", - "name": "id", - "type": "string" - }, - { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "comma separated tag", - "name": "tags", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Disables an AutoScale Vm Group", - "isasync": true, - "name": "disableAutoScaleVmGroup", - "params": [ - { - "description": "the ID of the autoscale group", - "length": 255, - "name": "id", - "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "required": true, - "type": "uuid" - } - ], - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "response": [ - {}, - { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, + {}, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the project name of the vm group", - "name": "project", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "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 public ip address id", - "name": "publicipid", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", + "description": "NICs of the VNF appliance", + "name": "vnfnics", "type": "list" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { @@ -36363,903 +34573,1341 @@ var preCache = `{ "type": "integer" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the account owning the vm group", - "name": "account", + "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": "Creates a snapshot policy for the account.", - "isasync": false, - "name": "createSnapshotPolicy", - "params": [ { - "description": "an optional field, whether to the display the policy to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", - "length": 255, - "name": "intervaltype", - "required": true, - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "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": "isdefault", + "type": "boolean" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + } + ], + "type": "set" }, + {}, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": true, + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": true, - "type": "uuid" - }, - { - "description": "time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)", - "length": 255, - "name": "schedule", - "required": true, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "A list of IDs of the zones in which the snapshots will be made available.The snapshots will always be made available in the zone in which the volume is present.", - "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" - }, - { - "description": "maximum number of snapshots to retain", - "length": 255, - "name": "maxsnaps", - "required": true, - "type": "integer" - }, - { - "description": "Map of tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - } - ], - "related": "updateSnapshotPolicy", - "response": [ - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" - }, - {}, - { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, - {}, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the ID of the snapshot policy", - "name": "id", - "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": "is this policy for display to the regular user", - "name": "fordisplay", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the account associated with the tag", + "description": "the account owning the security group", "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" }, { - "description": "tag key name", - "name": "key", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], "type": "set" }, { - "description": "the ID of the disk volume", - "name": "volumeid", - "type": "string" - } - ] - }, - { - "description": "create Tungsten-Fabric management network", - "isasync": false, - "name": "createTungstenFabricManagementNetwork", - "params": [ - { - "description": "the ID of pod", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, - {} - ] - }, - { - "description": "Disables HA for a zone", - "isasync": true, - "name": "disableHAForZone", - "params": [ - { - "description": "ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "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", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "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.11" - }, - { - "description": "list Tungsten-Fabric firewall rule", - "isasync": false, - "name": "listTungstenFabricFirewallRule", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", - "length": 255, - "name": "firewallpolicyuuid", - "required": false, + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the uuid of Tungsten-Fabric firewall rule", - "length": 255, - "name": "firewallruleuuid", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule source tag", - "name": "srctag", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "Tungsten-Fabric firewall rule uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source address group", - "name": "srcaddressgroup", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, {}, { - "description": "Tungsten-Fabric firewall rule destination network", - "name": "destnetwork", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" - } - ] - }, - { - "description": "List system virtual machines.", - "isasync": false, - "name": "listSystemVms", - "params": [ - { - "description": "the ID of the system VM", - "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": false, - "type": "uuid" - }, - { - "description": "the Pod ID of the system VM", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" }, { - "description": "the state of the system VM", - "length": 255, - "name": "state", - "required": false, + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the storage ID where vm's volumes belong to", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "3.0.1", - "type": "uuid" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", - "length": 255, - "name": "systemvmtype", - "required": false, + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the host ID of the system VM", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" - }, - { - "description": "the Zone ID of the system VM", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the name of the system VM", - "length": 255, + "description": "the name of the virtual machine", "name": "name", - "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "response": [ - { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + } + ], + "type": "set" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the name of the service offering of the 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", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, - {}, { - "description": "the name of the system VM", - "name": "name", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "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 system virtual machine.", - "name": "serviceofferingid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "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 system VM type", - "name": "systemvmtype", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the control state of the host for the system VM", + "description": "the control state of the host for the virtual machine", "name": "hostcontrolstate", "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" - }, + } + ] + }, + { + "description": "Manages a GPU device", + "isasync": false, + "name": "manageGpuDevice", + "params": [ { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" - }, + "description": "comma separated list of IDs of the GPU device", + "length": 255, + "name": "ids", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", + "required": true, + "type": "list" + } + ], + "response": [ { - "description": "the network domain for the system VM", - "name": "networkdomain", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {}, { - "description": "the state of the system VM", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - }, + } + ], + "since": "4.21.0" + }, + { + "description": "Deletes a Kubernetes cluster", + "isasync": true, + "name": "deleteKubernetesSupportedVersion", + "params": [ + { + "description": "the ID of the Kubernetes supported version", + "length": 255, + "name": "id", + "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "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.", + "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, { - "description": "Adds an API permission to a role", + "description": "list baremetal rack configuration", "isasync": false, - "name": "createRolePermission", + "name": "listBaremetalRct", "params": [ { - "description": "The rule permission, allow or deny. Default: deny.", + "description": "", "length": 255, - "name": "permission", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "The description of the role permission", + "description": "List by keyword", "length": 255, - "name": "description", + "name": "keyword", "required": false, "type": "string" }, { - "description": "ID of the role", + "description": "", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "addBaremetalRct", + "response": [ + { + "description": "id of rct", + "name": "id", + "type": "string" }, { - "description": "The API name or wildcard rule such as list*", + "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": "url", + "name": "url", + "type": "string" + } + ] + }, + { + "description": "Lists available certificate authority providers in CloudStack", + "isasync": false, + "name": "listCAProviders", + "params": [ + { + "description": "List CA service provider by name", "length": 255, - "name": "rule", - "required": true, + "name": "name", + "required": false, "type": "string" } ], - "related": "listRolePermissions", + "related": "", "response": [ { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the description of the CA service provider", + "name": "description", "type": "string" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the CA service provider name", + "name": "name", "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + } + ], + "since": "4.11.0" + }, + { + "description": "Delete site to site vpn customer gateway", + "isasync": true, + "name": "deleteVpnCustomerGateway", + "params": [ + { + "description": "id of customer gateway", + "length": 255, + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", + "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 ID of the role to which the role permission belongs", - "name": "roleid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ] + }, + { + "description": "Lists all port forwarding rules for an IP address.", + "isasync": false, + "name": "listPortForwardingRules", + "params": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the ID of the role permission", + "description": "Lists rule with the specified ID.", + "length": 255, "name": "id", + "related": "updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "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": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the description of the role permission", - "name": "description", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "Creates a project", - "isasync": true, - "name": "createProject", - "params": [ + }, { - "description": "ID of the account owning a project", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "the ID of IP address of the port forwarding services", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "since": "4.15.0", "type": "uuid" }, { - "description": "domain ID of the account owning a project", + "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 only resources belonging to the domain specified", "length": 255, "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "account who will be Admin for the project", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "The display text of the project, defaults to the 'name´.", + "description": "list port forwarding rules for certain network", "length": 255, - "name": "displaytext", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "since": "4.3", + "type": "uuid" }, { - "description": "name of the project", + "description": "", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" } ], - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", "response": [ { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the list of resource tags associated with vm", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -37268,8 +35916,8 @@ var preCache = `{ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -37278,13 +35926,13 @@ var preCache = `{ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -37293,66 +35941,63 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, + {}, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, + {}, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -37361,188 +36006,240 @@ var preCache = `{ "type": "integer" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, - {}, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" - }, + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + } + ] + }, + { + "description": "Allocates IP addresses in respective Pod of a Zone", + "isasync": false, + "name": "acquirePodIpAddress", + "params": [ { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "Pod ID", + "length": 255, + "name": "podid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ {}, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", + "description": "the ID of the pod the IP address", + "name": "id", + "type": "long" + }, + { + "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 allocated for this project", - "name": "iptotal", + "description": "MAC address of the pod the IP", + "name": "hostmac", "type": "long" }, + {}, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "Gateway for Pod ", + "name": "gateway", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" + "description": "the ID of the nic", + "name": "nicid", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the ID of the pod the IP address belongs to", + "name": "podid", + "type": "long" }, { - "description": "the id of the project", - "name": "id", + "description": "CIDR of the Pod", + "name": "cidr", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "Allocated IP address", + "name": "ipaddress", "type": "string" - }, + } + ] + }, + { + "description": "Enables out-of-band management for a cluster", + "isasync": true, + "name": "enableOutOfBandManagementForCluster", + "params": [ { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" - }, + "description": "the ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", + "response": [ { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, + {}, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "the state of the project", - "name": "state", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" }, + {}, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" } ], - "since": "3.0.0" + "since": "4.9.0" }, { - "description": "Assigns a certificate to a load balancer rule", - "isasync": true, - "name": "assignCertToLoadBalancer", + "description": "Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them.", + "isasync": false, + "name": "updateTemplatePermissions", "params": [ { - "description": "the ID of the certificate", + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "certid", - "related": "uploadSslCert", - "required": true, - "type": "uuid" + "name": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "list" }, { - "description": "the ID of the load balancer rule", + "description": "permission operator (add, remove, reset)", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "name": "op", + "required": false, + "type": "string" + }, + { + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" + }, + { + "description": "true for public template/iso, false for private templates/isos", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + }, + { + "description": "the template ID", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" + }, + { + "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accounts", + "required": false, + "type": "list" + }, + { + "description": "true for featured template/iso, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" } ], "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -37553,13 +36250,12 @@ var preCache = `{ "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", @@ -37568,1740 +36264,1694 @@ var preCache = `{ ] }, { - "description": "Adds a Cisco Vnmc Controller", - "isasync": false, - "name": "addCiscoVnmcResource", + "description": "Resets the password for virtual machine. The virtual machine must be in a \"Stopped\" state and the template must already support this feature for this command to take effect. [async]", + "isasync": true, + "name": "resetPasswordForVirtualMachine", "params": [ { - "description": "Credentials to access the Cisco VNMC Controller API", + "description": "The new password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, "name": "password", - "required": true, - "type": "string" - }, - { - "description": "Credentials to access the Cisco VNMC Controller API", - "length": 255, - "name": "username", - "required": true, + "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "the Physical Network ID", + "description": "The ID of the virtual machine", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "id", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": true, "type": "uuid" - }, - { - "description": "Hostname or ip address of the Cisco VNMC Controller.", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" } ], - "related": "listCiscoVnmcResources", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "response": [ - {}, - {}, - {}, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, - {}, - {} - ] - }, - { - "description": "Detaches a disk volume from a virtual machine.", - "isasync": true, - "name": "detachVolume", - "params": [ { - "description": "the ID of the virtual machine where the volume is detached from", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the device ID on the virtual machine where volume is detached from", - "length": 255, - "name": "deviceid", - "required": false, - "type": "long" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": false, - "type": "uuid" - } - ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "response": [ - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "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" + } + ], + "type": "set" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "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 name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, - { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "pod id of the volume", - "name": "podid", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the date the disk volume was created", + "description": "the date when this virtual machine was created", "name": "created", "type": "date" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the disk utilization", - "name": "utilization", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, - {}, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - {}, { "description": "the ID of the ISO attached to the virtual machine", "name": "isoid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "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 chain info of the volume", - "name": "chaininfo", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the status of the volume", - "name": "status", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - } - ] - }, - { - "description": "Replaces ACL associated with a network or private gateway", - "isasync": true, - "name": "replaceNetworkACLList", - "params": [ - { - "description": "the ID of the network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "the ID of the network ACL", - "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", - "required": true, - "type": "uuid" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "the ID of the private gateway", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", - "required": false, - "type": "uuid" - } - ], - "response": [ - {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "list Tungsten-Fabric address group", - "isasync": false, - "name": "listTungstenFabricAddressGroup", - "params": [ + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric address group", - "length": 255, - "name": "addressgroupuuid", - "required": false, + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "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 ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "createTungstenFabricAddressGroup", - "response": [ - {}, + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "Tungsten-Fabric address group uuid", - "name": "uuid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "Tungsten-Fabric address group name", - "name": "name", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Tungsten-Fabric address group ip prefix length", - "name": "ipprefixlen", - "type": "int" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "Tungsten-Fabric address group ip prefix", - "name": "ipprefix", - "type": "string" - } - ] - }, - { - "description": "Marks a default zone for this account", - "isasync": true, - "name": "markDefaultZoneForAccount", - "params": [ + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, { - "description": "The Zone ID with which the account is to be marked.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "Marks the account that belongs to the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "Name of the account that is to be marked.", - "length": 255, - "name": "account", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": true, + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" - } - ], - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "response": [ + }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, - {}, { - "description": "id of the Domain the account belongs to", + "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, + {}, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the list of users associated with account", - "name": "user", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the api key of the user", - "name": "apikey", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the name of the role", - "name": "rolename", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the user email address", - "name": "email", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the user state", - "name": "state", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" } ], - "type": "list" - }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "type": "set" }, { - "description": "details for the account", - "name": "accountdetails", + "description": "Vm details in key/value pairs.", + "name": "details", "type": "map" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the name of the account", - "name": "name", - "type": "string" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" - }, - {}, - { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" - }, - { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "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 number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the state of the account", - "name": "state", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" - } - ], - "since": "4.0" - }, - { - "description": "Enables out-of-band management for a zone", - "isasync": true, - "name": "enableOutOfBandManagementForZone", - "params": [ - { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,issueOutOfBandManagementPowerAction", - "response": [ - { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" - }, - { - "description": "the operation result description", - "name": "description", - "type": "string" - }, - { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" - }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, - { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" - }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - {}, - {} - ], - "since": "4.9.0" - }, - { - "description": "Lists LDAP Users according to the specifications from the user request.", - "isasync": false, - "name": "listLdapUsers", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "Determines what type of filter is applied on the list of users returned from LDAP.\n\tvalid values are\n\t'NoFilter'\t no filtering is done,\n\t'LocalDomain'\tusers already in the current or requested domain will be filtered out of the result list,\n\t'AnyDomain'\tusers that already exist anywhere in cloudstack will be filtered out, and\n\t'PotentialImport'\tall users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource", - "length": 255, - "name": "userfilter", - "required": false, - "since": "4.13", - "type": "string" - }, - { - "description": "linked domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter", - "length": 255, - "name": "listtype", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "The user's lastname", - "name": "lastname", - "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 email", - "name": "email", - "type": "string" - }, - { - "description": "The user's firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "The user's principle", - "name": "principal", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "The user's domain", - "name": "domain", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "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" + } + ], + "type": "set" + }, + { + "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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "tag value", + "name": "value", + "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" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "The user's username", - "name": "username", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } - ], - "since": "4.2.0" + ] }, { - "description": "Revokes certificate using configured CA plugin", - "isasync": true, - "name": "revokeCertificate", + "description": "Deletes an OS category", + "isasync": false, + "name": "deleteOsCategory", "params": [ { - "description": "The certificate CN", - "length": 255, - "name": "cn", - "required": false, - "type": "string" - }, - { - "description": "The certificate serial number, as a hex value", + "description": "ID of the OS category", "length": 255, - "name": "serial", + "name": "id", + "related": "listOsCategories,addOsCategory", "required": true, - "type": "string" - }, - { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", - "length": 255, - "name": "provider", - "required": false, - "type": "string" + "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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], - "since": "4.11.0" + "since": "4.21.0" }, { - "description": "Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a \"Stopped\" state for this command to take effect.", + "description": "Lists Brocade VCS Switches", "isasync": false, - "name": "changeServiceForSystemVm", + "name": "listBrocadeVcsDevices", "params": [ { - "description": "The ID of the system vm", + "description": "Brocade VCS switch ID", "length": 255, - "name": "id", - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": true, + "name": "vcsdeviceid", + "related": "listBrocadeVcsDevices", + "required": false, "type": "uuid" }, { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "description": "List by keyword", "length": 255, - "name": "details", + "name": "keyword", "required": false, - "type": "map" + "type": "string" }, { - "description": "the service offering ID to apply to the system vm", + "description": "the Physical Network ID", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, "type": "uuid" - } - ], - "related": "migrateSystemVm,startSystemVm", - "response": [ - { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" - }, - { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the state of the system VM", - "name": "state", - "type": "string" - }, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { - "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.", + "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the principal switch Ip address", + "name": "hostname", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", "type": "string" }, {}, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" - }, - { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "device name", + "name": "brocadedevicename", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, + } + ] + }, + { + "description": "link an existing cloudstack domain to group or OU in ldap", + "isasync": false, + "name": "linkDomainToLdap", + "params": [ { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "ldapdomain", + "required": false, "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "type of the ldap name. GROUP or OU", + "length": 255, + "name": "type", + "required": true, "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "domain admin username in LDAP ", + "length": 255, + "name": "admin", + "required": false, "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" + "description": "The id of the domain which has to be linked to LDAP.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" }, { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" - }, + "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "length": 255, + "name": "accounttype", + "required": true, + "type": "integer" + } + ], + "related": "linkAccountToLdap", + "response": [ { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "Type of the account to auto import", + "name": "accounttype", + "type": "int" }, + {}, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "Domain Admin accountId that is created", + "name": "accountid", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", "type": "string" }, + {}, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "id of the Domain which is linked to LDAP", + "name": "domainid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", "type": "string" - }, + } + ], + "since": "4.6.0" + }, + { + "description": "Cancels maintenance of the management server", + "isasync": false, + "name": "cancelMaintenance", + "params": [ { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" + "description": "the id of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": true, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Rebalance agents (applicable for indirect agents, ensure the settings 'host' and 'indirect.agent.lb.algorithm' are properly configured) after cancelling maintenance, default is true", + "length": 255, + "name": "rebalance", + "required": false, "type": "boolean" - }, + } + ], + "related": "prepareForMaintenance,prepareForShutdown,cancelShutdown,readyForShutdown", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" - }, - { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "The id of the management server", + "name": "managementserverid", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" + "description": "the state of the management server", + "name": "state", + "type": "state" }, { - "description": "public vlan range", - "name": "publicvlan", + "description": "The host agents this management server is responsible for", + "name": "agents", "type": "list" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "type": "string" + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", + "type": "long" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", "type": "boolean" }, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", + "type": "boolean" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" }, - {} - ] + {}, + { + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + } + ], + "since": "4.21.0" }, { - "description": "Update SIOC info", + "description": "Setup the 2FA for the user.", "isasync": false, - "name": "updateSiocInfo", + "name": "setupUserTwoFactorAuthentication", "params": [ { - "description": "Storage Pool ID", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" - }, - { - "description": "Shares per GB", + "description": "two factor authentication code", "length": 255, - "name": "sharespergb", - "required": true, - "type": "integer" + "name": "provider", + "required": false, + "type": "string" }, { - "description": "Limit IOPS per GB", + "description": "Enabled by default, provide false to disable 2FA", "length": 255, - "name": "limitiopspergb", - "required": true, - "type": "integer" + "name": "enable", + "required": false, + "type": "boolean" }, { - "description": "Zone ID", + "description": "optional: the id of the user for which 2FA has to be disabled", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, "type": "uuid" - }, - { - "description": "Notify if IOPS above this value", - "length": 255, - "name": "iopsnotifythreshold", - "required": true, - "type": "integer" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "secret code that needs to be registered with authenticator", + "name": "secretcode", + "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "The return message from the operation ('Success' if successful)", - "name": "msg", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the user name", + "name": "username", "type": "string" }, - {} + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + } ], - "since": "4.11.0" + "since": "4.18.0" }, { - "description": "Create VM Schedule", + "description": "Lists site to site vpn customer gateways", "isasync": false, - "name": "createVMSchedule", + "name": "listVpnCustomerGateways", "params": [ { - "description": "start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "startdate", + "name": "isrecursive", "required": false, - "type": "date" + "type": "boolean" }, { - "description": "Description of the schedule", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "description", + "name": "account", "required": false, "type": "string" }, { - "description": "Action to take on the VM (start/stop/restart/force_stop/force_reboot).", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "action", - "required": true, - "type": "string" + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "description": "", "length": 255, - "name": "schedule", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "ID of the VM for which schedule is to be defined", + "description": "", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "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": "enddate", + "name": "listall", "required": false, - "type": "date" + "type": "boolean" }, { - "description": "Enable VM schedule. Defaults to true", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "enabled", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "description": "id of the customer gateway", "length": 255, - "name": "timezone", - "required": true, + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" } ], - "related": "updateVMSchedule", + "related": "createVpnCustomerGateway,updateVpnCustomerGateway", "response": [ { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" }, - {}, { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the ID of VM schedule", - "name": "id", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": "Timezone of the schedule", - "name": "timezone", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "name of the customer gateway", + "name": "name", + "type": "string" + }, + { + "description": "IKE policy of customer gateway", + "name": "ikepolicy", + "type": "string" + }, + { + "description": "IPsec policy of customer gateway", + "name": "esppolicy", + "type": "string" + }, + { + "description": "guest ip of the customer gateway", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { @@ -39310,61 +37960,141 @@ var preCache = `{ "type": "integer" }, { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "description": "the owner", + "name": "account", + "type": "string" }, { - "description": "Description of VM schedule", - "name": "description", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "VM schedule is enabled", - "name": "enabled", + "description": "the project id", + "name": "projectid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "Action", - "name": "action", - "type": "action" + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", + "type": "string" + } + ] + }, + { + "description": "Deletes a Kubernetes cluster", + "isasync": true, + "name": "deleteKubernetesCluster", + "params": [ + { + "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", + "length": 255, + "name": "cleanup", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false", + "length": 255, + "name": "expunge", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" } ], - "since": "4.19.0" + "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" + } + ] }, { - "description": "List the IP forwarding rules", + "description": "Lists Webhooks", "isasync": false, - "name": "listIpForwardingRules", + "name": "listWebhooks", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "The ID of the Webhook", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "createWebhook,listWebhooks,listWebhookDeliveries", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "The name of the Webhook", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "name", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "List by keyword", @@ -39374,35 +38104,32 @@ var preCache = `{ "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "The scope of the Webhook", "length": 255, - "name": "account", + "name": "scope", "required": false, "type": "string" }, { - "description": "Lists rule with the specified ID.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list the rule belonging to this public IP address", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Lists all rules applied to the specified VM.", + "description": "The state of the Webhook", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -39412,11 +38139,12 @@ var preCache = `{ "type": "integer" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "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.", @@ -39426,88 +38154,83 @@ var preCache = `{ "type": "boolean" } ], - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", + "related": "createWebhook,listWebhookDeliveries", "response": [ + {}, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, + {}, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the state of the rule", - "name": "state", + "description": "The name of the Webhook", + "name": "name", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {}, - {}, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "The state of the Webhook", + "name": "state", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "The ID of the Webhook", + "name": "id", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "The account associated with the Webhook", + "name": "account", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, { @@ -39516,242 +38239,130 @@ var preCache = `{ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "list" + "description": "The secret key for the Webhook", + "name": "secretkey", + "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "Creates an instant snapshot of a volume.", + "description": "Creates a global load balancer rule", "isasync": true, - "name": "createSnapshot", + "name": "createGlobalLoadBalancerRule", "params": [ { - "description": "asynchronous backup if true", + "description": "domain name for the GSLB service.", "length": 255, - "name": "asyncbackup", - "required": false, - "type": "boolean" + "name": "gslbdomainname", + "required": true, + "type": "string" }, { - "description": "A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", - "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, - "since": "4.19.0", - "type": "list" + "type": "string" }, { - "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", + "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", "length": 255, - "name": "locationtype", + "name": "account", "required": false, "type": "string" }, { - "description": "quiesce vm if true", + "description": "name of the load balancer rule", "length": 255, - "name": "quiescevm", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the name of the snapshot", + "description": "GSLB service type (tcp, udp, http)", "length": 255, - "name": "name", - "required": false, + "name": "gslbservicetype", + "required": true, "type": "string" }, { - "description": "Map of tags (key/value pairs)", + "description": "load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", "length": 255, - "name": "tags", + "name": "gslblbmethod", "required": false, - "type": "map" + "type": "string" }, { - "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", + "description": "the domain ID associated with the load balancer", "length": 255, - "name": "policyid", - "related": "updateSnapshotPolicy", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "The ID of the disk volume", + "description": "region where the global load balancer is going to be created.", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "regionid", + "related": "addRegion,updateRegion,listRegions", "required": true, - "type": "uuid" - }, - { - "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", + "description": "session sticky method (sourceip) if not specified defaults to sourceip", "length": 255, - "name": "account", + "name": "gslbstickysessionmethodname", "required": false, "type": "string" } ], - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "response": [ { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "type": "string" - }, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" - }, - { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" - }, - { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the status of the template", - "name": "status", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the account associated with the snapshot", + "description": "the account of the load balancer rule", "name": "account", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, {}, { - "description": "name of the snapshot", - "name": "name", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { @@ -39760,143 +38371,231 @@ var preCache = `{ "type": "integer" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, + {}, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "List of load balancer rules that are part of GSLB rule", + "name": "loadbalancerrule", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the list of resource tags associated with load balancer", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the project id of the load balancer", "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", "type": "string" } ], - "type": "set" - }, - { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" - }, - { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "type": "list" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" } ] }, { - "description": "Deletes a vmsnapshot.", + "description": " delete a netscaler load balancer device", "isasync": true, - "name": "deleteVMSnapshot", + "name": "deleteNetscalerLoadBalancer", "params": [ { - "description": "The ID of the VM snapshot", + "description": "netscaler load balancer device ID", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", "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" }, {}, { @@ -39904,225 +38603,175 @@ var preCache = `{ "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} - ], - "since": "4.2.0" + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] }, { - "description": "Lists storage pool metrics", + "description": "List resource tag(s)", "isasync": false, - "name": "listStoragePoolsMetrics", + "name": "listTags", "params": [ { - "description": "the scope of the storage pool", + "description": "list by resource type", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "resourcetype", "required": false, "type": "string" }, { - "description": "list storage pools belongig to the specific cluster", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the storage pool path", + "description": "list by resource id", "length": 255, - "name": "path", + "name": "resourceid", "required": false, "type": "string" }, { - "description": "the IP address for the storage pool", + "description": "List by keyword", "length": 255, - "name": "ipaddress", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of the storage pool", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the Pod ID for the storage pool", + "description": "list by key", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "key", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the Zone ID for the storage pool", + "description": "list by customer name", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "customer", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "host ID of the storage pools", + "description": "list by value", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "value", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the status of the storage pool", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "status", + "name": "account", "required": false, "type": "string" }, { - "description": "List by keyword", + "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": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the name of the storage pool", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "name", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "", + "related": "listResourceDetails", "response": [ { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, - { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" - }, - { - "description": "storage allocated disable threshold exceeded", - "name": "storageallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "disk size allocated in GiB", - "name": "disksizeallocatedgb", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "storage usage notification threshold exceeded", - "name": "storageusagethreshold", - "type": "boolean" - }, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, + {}, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, - { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" - }, {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, - {}, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -40131,113 +38780,86 @@ var preCache = `{ "type": "integer" }, { - "description": "storage usage disable threshold exceeded", - "name": "storageusagedisablethreshold", - "type": "boolean" - }, - { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" - }, - { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, + } + ], + "since": "4.0.0" + }, + { + "description": "List user and system VMs that need to be stopped and destroyed respectively for changing the scope of the storage pool from Zone to Cluster.", + "isasync": false, + "name": "listAffectedVmsForStorageScopeChange", + "params": [ { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the storage pool path", - "name": "path", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "disk size in GiB", - "name": "disksizetotalgb", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "disk size unallocated in GiB", - "name": "disksizeunallocatedgb", - "type": "string" + "description": "the Id of the storage pool on which change scope operation is being done", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" - }, + "description": "the Id of the cluster the scope of the storage pool is being changed to", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the cluster name for the VM", + "name": "clustername", "type": "string" }, { - "description": "disk size used in GiB", - "name": "disksizeusedgb", + "description": "the hostname for the VM", + "name": "hostname", "type": "string" }, { - "description": "storage allocated notification threshold exceeded", - "name": "storageallocatedthreshold", - "type": "boolean" - }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the cluster ID for the VM", + "name": "clusterid", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } - ], - "since": "4.9.3" - }, - { - "description": "Unmanage a guest virtual machine.", - "isasync": true, - "name": "unmanageVirtualMachine", - "params": [ - { - "description": "The ID of the virtual machine to unmanage", - "length": 255, + "description": "the ID of the VM", "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - { - "description": "result of the unmanage VM operation", - "name": "success", - "type": "boolean" + "type": "string" }, { - "description": "details of the unmanage VM operation", - "name": "details", + "description": "the type of VM", + "name": "type", "type": "string" }, {}, @@ -40247,71 +38869,78 @@ var preCache = `{ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host ID for the VM", + "name": "hostid", + "type": "string" + }, + {}, + { + "description": "the name of the VM", + "name": "name", + "type": "string" } ], - "since": "4.15.0" + "since": "4.19.1" }, { - "description": "Starts a router.", + "description": "Create a virtual router element.", "isasync": true, - "name": "rebootRouter", + "name": "createVirtualRouterElement", "params": [ { - "description": "the ID of the router", + "description": "the network service provider ID of the virtual router element", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": true, "type": "uuid" }, { - "description": "Force reboot the router (Router is force Stopped and then Started)", + "description": "The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter", "length": 255, - "name": "forced", + "name": "providertype", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "uuid" } ], - "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "related": "configureVirtualRouterElement,listVirtualRouterElements", "response": [ { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, + {}, { - "description": "the account associated with the router", - "name": "account", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, + {}, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { @@ -40320,905 +38949,996 @@ var preCache = `{ "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the project name of the address", + "name": "project", + "type": "string" + } + ] + }, + { + "description": "Creates a VPC", + "isasync": true, + "name": "createVPC", + "params": [ + { + "description": "the second IPv4 DNS for the VPC", + "length": 255, + "name": "dns2", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "IPV4 address to be assigned to the public interface of the network router.This address will be used as source NAT address for the networks in ths VPC. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "length": 255, + "name": "sourcenatipaddress", + "required": false, + "since": "4.19", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - } - ], + "description": "Ids of the Bgp Peer for the VPC", + "length": 255, + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "required": false, + "since": "4.20.0", "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "length": 255, + "name": "cidr", + "required": false, + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "MTU to be configured on the network VR's public facing interfaces", + "length": 255, + "name": "publicmtu", + "required": false, + "since": "4.18.0", "type": "integer" }, { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "the CIDR size of VPC. For regular users, this is required for VPC with ROUTED mode.", + "length": 255, + "name": "cidrsize", + "required": false, + "since": "4.20.0", + "type": "integer" }, { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" + "description": "the AS Number of the VPC tiers", + "length": 255, + "name": "asnumber", + "required": false, + "since": "4.20.0", + "type": "long" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "the ID of the VPC offering", + "length": 255, + "name": "vpcofferingid", + "related": "updateVPCOffering,listVPCOfferings", + "required": true, + "type": "uuid" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "VPC network domain. All networks inside the VPC will belong to this domain", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the version of template", - "name": "version", + "description": "the first IPv4 DNS for the VPC", + "length": 255, + "name": "dns1", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the second IPv6 DNS for the VPC", + "length": 255, + "name": "ip6dns2", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "The display text of the VPC, defaults to its 'name'.", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" + "description": "create VPC for the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the first IPv6 DNS for the VPC", + "length": 255, + "name": "ip6dns1", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the VPC. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default.", + "length": 255, + "name": "start", + "required": false, + "since": "4.3", "type": "boolean" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the name of the VPC", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" + "description": "an optional field, whether to the display the vpc to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, + "description": "(optional) for NSX based VPCs: when set to true, use the VR IP as nameserver, otherwise use DNS1 and DNS2", + "length": 255, + "name": "userouteripresolver", + "required": false, + "type": "boolean" + } + ], + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "response": [ { - "description": "the template name for the router", - "name": "templatename", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { - "description": "the id of the router", - "name": "id", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the network domain for the router", + "description": "the network domain of the VPC", "name": "networkdomain", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "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 vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - } - ], + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", "type": "set" - } - ] - }, - { - "description": "list the vm nics IP to NIC", - "isasync": false, - "name": "listNics", - "params": [ - { - "description": "the ID of the nic to list IPs", - "length": 255, - "name": "nicid", - "related": "listNics", - "required": false, - "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "true VPC requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the ID of the vm", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "list nic of the specific vm's network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, - {}, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" }, + {}, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + } + ], "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" + } + ] + }, + { + "description": "Removes detail for the Resource.", + "isasync": true, + "name": "removeResourceDetail", + "params": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Delete detail by resource type", + "length": 255, + "name": "resourcetype", + "required": true, "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Delete details matching key/value pairs", + "length": 255, + "name": "key", + "required": false, + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Delete details for resource id", + "length": 255, + "name": "resourceid", + "required": true, "type": "string" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the name of the corresponding network", - "name": "networkname", + "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Lists all supported OS types for this cloud.", + "isasync": false, + "name": "listOsTypes", + "params": [ + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.18.1", + "type": "boolean" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "list by Os type Id", + "length": 255, + "name": "id", + "related": "listOsTypes,addGuestOs", + "required": false, + "type": "uuid" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, - {}, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "list os by description", + "length": 255, + "name": "description", + "required": false, + "since": "3.0.1", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list by Os Category id", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories,addOsCategory", + "required": false, + "type": "uuid" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "addGuestOs", + "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "the name of the OS type", + "name": "name", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" }, + {}, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the name of the OS category", + "name": "oscategoryname", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the name/description of the OS type", + "name": "description", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "is the guest OS visible for the users", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the ID of the OS category", + "name": "oscategoryid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the OS type", + "name": "id", "type": "string" } ] }, { - "description": "Create a new keypair and returns the private key", + "description": "Updates a GPU card definition in the system", "isasync": false, - "name": "createSSHKeyPair", + "name": "updateGpuCard", "params": [ { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "description": "the device name of the GPU card", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "devicename", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Name of the keypair", + "description": "the vendor name of the GPU card", "length": 255, - "name": "name", - "required": true, + "name": "vendorname", + "required": false, "type": "string" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "the ID of the GPU card", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "id", + "related": "updateGpuCard,listGpuCards", + "required": true, + "type": "uuid" }, { - "description": "an optional project for the ssh key", + "description": "the display name of the GPU card", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "name", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "", + "related": "listGpuCards", "response": [ { - "description": "the domain name of the keypair owner", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the owner of the keypair", - "name": "account", + "description": "the display name of the GPU card", + "name": "name", "type": "string" }, - {}, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "the vendor ID of the GPU card", + "name": "vendorid", "type": "string" }, {}, { - "description": "ID of the ssh keypair", + "description": "the ID of the GPU card", "name": "id", "type": "string" }, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "the device ID of the GPU card", + "name": "deviceid", "type": "string" }, + {}, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "the device name of the GPU card", + "name": "devicename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "description": "the vendor name of the GPU card", + "name": "vendorname", + "type": "string" + } + ], + "since": "4.21.0" + }, + { + "description": "Removes a Guest OS from listing.", + "isasync": true, + "name": "removeGuestOs", + "params": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "ID of the guest OS", + "length": 255, + "name": "id", + "related": "addGuestOs", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "Private key", - "name": "privatekey", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Name of the keypair", - "name": "name", + "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.4.0" }, { - "description": "Creates an instant snapshot of a volume from existing vm snapshot.", + "description": "Detaches any ISO file (if any) currently attached to a virtual machine.", "isasync": true, - "name": "createSnapshotFromVMSnapshot", + "name": "detachIso", "params": [ { - "description": "The ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": true, - "type": "uuid" - }, - { - "description": "The ID of the VM snapshot", + "description": "The ID of the virtual machine", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, { - "description": "the name of the snapshot", + "description": "If true, ejects the ISO before detaching on VMware. Default: false", "length": 255, - "name": "name", + "name": "forced", "required": false, - "type": "string" + "since": "4.15.1", + "type": "boolean" } ], - "related": "copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "response": [ { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, - {}, { - "description": "name of the snapshot", - "name": "name", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, - {}, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": " the date the snapshot was created", + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", "name": "created", "type": "date" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" + "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": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { @@ -41226,13 +39946,13 @@ var preCache = `{ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -41241,28 +39961,33 @@ var preCache = `{ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -41271,641 +39996,1290 @@ var preCache = `{ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + } + ], + "type": "set" + }, + { + "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" - } - ], - "since": "4.10.0" - }, - { - "description": "list Tungsten-Fabric service group", - "isasync": false, - "name": "listTungstenFabricServiceGroup", - "params": [ + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "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" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "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": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "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 domain name of the security group", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "the uuid of Tungsten-Fabric service group", - "length": 255, - "name": "servicegroupuuid", - "required": false, + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" - } - ], - "related": "createTungstenFabricServiceGroup", - "response": [ - {}, + }, { - "description": "Tungsten-Fabric service group protocol", - "name": "protocol", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "Tungsten-Fabric service group name", - "name": "name", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "Tungsten-Fabric service group end port", - "name": "endport", - "type": "int" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "Tungsten-Fabric service group uuid", - "name": "uuid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric service group start port", - "name": "startport", - "type": "int" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "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": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ] - }, - { - "description": "Authorizes a particular egress rule for this security group", - "isasync": true, - "name": "authorizeSecurityGroupEgress", - "params": [ + }, { - "description": "user to security group mapping", - "length": 255, - "name": "usersecuritygrouplist", - "required": false, - "type": "map" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", - "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", - "required": false, - "type": "uuid" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, + "description": "NICs of the VNF appliance", + "name": "vnfnics", "type": "list" }, { - "description": "an optional project of the security group", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "type of the icmp message being sent", - "length": 255, - "name": "icmptype", - "required": false, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "an optional account for the security group. Must be used with domainId.", - "length": 255, + "description": "the account associated with the virtual machine", "name": "account", - "required": false, "type": "string" }, { - "description": "error code for this icmp message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "start port for this egress rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "end port for this egress rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", - "length": 255, - "name": "securitygroupname", - "required": false, + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, + {}, { - "description": "TCP is default. UDP is the other supported protocol", - "length": 255, - "name": "protocol", - "required": false, + "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" - } - ], - "related": "authorizeSecurityGroupIngress", - "response": [ + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, {}, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", + "description": "the account owning the affinity group", "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "tag key name", - "name": "key", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, {}, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vm", + "name": "project", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Lists storage pools.", + "description": "Update the custom action", "isasync": false, - "name": "listStoragePools", + "name": "updateCustomAction", "params": [ { - "description": "the ID of the storage pool", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the Pod ID for the storage pool", + "description": "ID of the custom action", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, + "name": "id", + "related": "addCustomAction,listCustomActions", + "required": true, "type": "uuid" }, { - "description": "the IP address for the storage pool", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - }, - { - "description": "host ID of the storage pools", + "description": "Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 3 seconds", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "timeout", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the name of the storage pool", + "description": "Parameters mapping for the action using keys - name, type, required. 'name' is mandatory. If 'type' is not specified then STRING will be used. If 'required' is not specified then false will be used. Example: parameters[0].name=xxx¶meters[0].type=BOOLEAN¶meters[0].required=true", "length": 255, - "name": "name", + "name": "parameters", "required": false, - "type": "string" + "type": "map" }, { - "description": "the scope of the storage pool", + "description": "List of role types allowed for the action", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "allowedroletypes", "required": false, - "type": "string" + "type": "list" }, { - "description": "List by keyword", + "description": "Optional boolean field, which indicates if details should be cleaned up or not (If set to true, details removed for this action, details field ignored; if false or not set, no action)", "length": 255, - "name": "keyword", + "name": "cleanupdetails", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list storage pools belongig to the specific cluster", + "description": "Whether the action is enabled or not", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "enabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the Zone ID for the storage pool", + "description": "Optional boolean field, which indicates if parameters should be cleaned up or not (If set to true, parameters will be removed for this action, parameters field ignored; if false or not set, no action)", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "cleanupparameters", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the status of the storage pool", + "description": "Error message that will be used on failure during execution of the action. Name of the action and and extension can be used in the - actionName, extensionName. Example: Failed to complete {{actionName}} for {{extensionName", "length": 255, - "name": "status", + "name": "errormessage", "required": false, "type": "string" }, { - "description": "", + "description": "Success message that will be used on successful execution of the action. Name of the action and and extension can be used in the - actionName, extensionName. Example: Successfully complete {{actionName}} for {{extensionName", "length": 255, - "name": "pagesize", + "name": "successmessage", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "The description of the command", "length": 255, - "name": "page", + "name": "description", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the storage pool path", + "description": "Type of the resource for actions", "length": 255, - "name": "path", + "name": "resourcetype", "required": false, "type": "string" } ], - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ + {}, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" + } + ], + "since": "4.21.0" + }, + { + "description": " delete a Palo Alto firewall device", + "isasync": true, + "name": "deletePaloAltoFirewall", + "params": [ + { + "description": "Palo Alto firewall device ID", + "length": 255, + "name": "fwdeviceid", + "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, + {}, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "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": "Executes a Webhook delivery", + "isasync": false, + "name": "executeWebhookDelivery", + "params": [ { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "The ID of the Webhook", + "length": 255, + "name": "webhookid", + "related": "createWebhook,listWebhookDeliveries", + "required": false, + "type": "uuid" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "The ID of the Webhook delivery for redelivery", + "length": 255, + "name": "id", + "related": "executeWebhookDelivery", + "required": false, + "type": "uuid" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "Secret key of the Webhook delivery", + "length": 255, + "name": "secretkey", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Payload of the Webhook delivery", + "length": 255, + "name": "payload", + "required": false, "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "If set to true then SSL verification will be done for the Webhook delivery otherwise not", + "length": 255, + "name": "sslverification", + "required": false, "type": "boolean" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "Payload URL of the Webhook delivery", + "length": 255, + "name": "payloadurl", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "The ID of the event", + "name": "eventid", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "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 ID of the Webhook delivery", + "name": "id", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "The ID of the management server which executed delivery", + "name": "managementserverid", "type": "string" }, + { + "description": "The end time of the Webhook delivery", + "name": "enddate", + "type": "date" + }, { "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", + "description": "Whether Webhook delivery succeeded or not", + "name": "success", + "type": "boolean" + }, + { + "description": "The response of the webhook delivery", + "name": "response", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "The payload of the webhook delivery", + "name": "payload", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "The ID of the Webhook", + "name": "webhookid", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "The type of the event", + "name": "eventtype", "type": "string" }, {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "The headers of the webhook delivery", + "name": "headers", + "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "The start time of the Webhook delivery", + "name": "startdate", + "type": "date" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "The name of the Webhook", + "name": "webhookname", + "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "The name of the management server which executed delivery", + "name": "managementservername", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Deletes a Pod.", + "isasync": false, + "name": "deletePod", + "params": [ + { + "description": "the ID of the Pod", + "length": 255, + "name": "id", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "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 objects at specified path on an image store.", + "description": "Lists Tungsten-Fabric providers", "isasync": false, - "name": "listImageStoreObjects", + "name": "listTungstenFabricProviders", "params": [ { - "description": "path to list on image store", + "description": "", "length": 255, - "name": "path", + "name": "page", "required": false, - "type": "string" - }, - { - "description": "id of the image store", - "length": 255, - "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -41915,36 +41289,40 @@ var preCache = `{ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], - "related": "", + "related": "createTungstenFabricProvider", "response": [ { - "description": "Is it a directory.", - "name": "isdirectory", - "type": "boolean" + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", + "type": "string" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, {}, { - "description": "Format of template associated with the data store object.", - "name": "format", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - {}, { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -41952,282 +41330,221 @@ var preCache = `{ "type": "string" }, { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "Template ID associated with the data store object.", - "name": "templateid", + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "type": "string" }, { - "description": "Volume ID associated with the data store object.", - "name": "volumeid", + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", "type": "string" }, { - "description": "Size is in Bytes.", - "name": "size", - "type": "long" + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", + "type": "string" }, { - "description": "Name of the data store object.", + "description": "Tungsten-Fabric provider name", "name": "name", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ], - "since": "4.19.0" + ] }, { - "description": "Updates a hypervisor capabilities.", + "description": "Lists all DeploymentPlanners available.", "isasync": false, - "name": "updateHypervisorCapabilities", + "name": "listDeploymentPlanners", "params": [ { - "description": "ID of the hypervisor capability", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listHypervisorCapabilities,updateHypervisorCapabilities", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", + "description": "", "length": 255, - "name": "maxdatavolumeslimit", + "name": "pagesize", "required": false, - "since": "4.16.0", "type": "integer" }, { - "description": "the maximum number of the hypervisor hosts per cluster ", + "description": "", "length": 255, - "name": "maxhostspercluster", + "name": "page", "required": false, - "since": "4.16.0", "type": "integer" - }, - { - "description": "set true to enable storage motion support for this hypervisor", - "length": 255, - "name": "storagemotionenabled", - "required": false, - "since": "4.16.0", - "type": "boolean" - }, - { - "description": "the max number of Guest VMs per host for this hypervisor.", - "length": 255, - "name": "maxguestslimit", - "required": false, - "type": "long" - }, - { - "description": "set true to enable VM snapshots for this hypervisor", - "length": 255, - "name": "vmsnapshotenabled", - "required": false, - "since": "4.16.0", - "type": "boolean" - }, - { - "description": "set true to enable security group for this hypervisor.", - "length": 255, - "name": "securitygroupenabled", - "required": false, - "type": "boolean" } ], - "related": "listHypervisorCapabilities", + "related": "", "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the hypervisor capabilities row", - "name": "id", + "description": "Deployment Planner name", + "name": "name", "type": "string" }, { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" - }, - { - "description": "true if security group is supported", - "name": "securitygroupenabled", - "type": "boolean" - }, - { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {} + ] + }, + { + "description": "Deletes a cluster.", + "isasync": false, + "name": "deleteCluster", + "params": [ { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", - "type": "boolean" - }, + "description": "the cluster ID", + "length": 255, + "name": "id", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ {}, - { - "description": "the maximum number of guest vms recommended for this hypervisor", - "name": "maxguestslimit", - "type": "long" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the hypervisor type", - "name": "hypervisor", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Find hosts suitable for migrating a virtual machine.", - "isasync": false, - "name": "findHostsForMigration", + "description": "Prepares a host for maintenance.", + "isasync": true, + "name": "prepareHostForMaintenance", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM", + "description": "the host ID", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], - "related": "", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "response": [ { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, + {}, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, - {}, { - "description": "the cpu average load on the host", - "name": "averageload", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the ID of the host", - "name": "id", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "the host version", - "name": "version", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "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": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "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", @@ -42235,78 +41552,99 @@ var preCache = `{ "type": "long" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "Used GPUs on the Host", + "name": "gpuused", "type": "long" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor ", - "name": "memorywithoverprovisioning", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, + {}, { - "description": "events available for the host", - "name": "events", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "long" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + { + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { @@ -42315,211 +41653,327 @@ var preCache = `{ "type": "integer" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", + "description": "the date and time the host was created", + "name": "created", "type": "date" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "true if migrating a vm to this host requires storage motion, false otherwise", - "name": "requiresStorageMotion", - "type": "boolean" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, + {}, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", - "name": "cpuwithoverprovisioning", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, - {}, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" + }, + { + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" - } - ] - }, - { - "description": "Enable a Cisco Nexus VSM device", - "isasync": true, - "name": "enableCiscoNexusVSM", - "params": [ + }, { - "description": "Id of the Cisco Nexus 1000v VSM device to be enabled", - "length": 255, - "name": "id", - "related": "listCiscoNexusVSMs,enableCiscoNexusVSM,disableCiscoNexusVSM", - "required": true, - "type": "uuid" - } - ], - "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", - "response": [ + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "events available for the host", + "name": "events", "type": "string" }, - {}, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "device name", - "name": "vsmdevicename", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "device state", - "name": "vsmdevicestate", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, - {}, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + } + ] + }, + { + "description": "Removes specified region", + "isasync": false, + "name": "removeRegion", + "params": [ + { + "description": "ID of the region to delete", + "length": 255, + "name": "id", + "required": true, + "type": "integer" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ] }, { - "description": "Return true if the specified account is allowed to create offerings with tags.", + "description": "Get Volume's iSCSI Name", "isasync": false, - "name": "isAccountAllowedToCreateOfferingsWithTags", + "name": "getVolumeiScsiName", "params": [ { - "description": "Account UUID", + "description": "CloudStack Volume UUID", "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" + "name": "volumeid", + "required": true, + "type": "string" } ], "related": "", "response": [ + {}, + { + "description": "Volume iSCSI Name", + "name": "volumeiScsiName", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - {}, - { - "description": "is domain admin allowed to create offerings with tags", - "name": "isallowed", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -42528,508 +41982,699 @@ var preCache = `{ ] }, { - "description": "Dedicates a guest vlan range to an account", - "isasync": false, - "name": "dedicateGuestVlanRange", + "description": "Updates an existing autoscale vm group.", + "isasync": true, + "name": "updateAutoScaleVmGroup", "params": [ { - "description": "domain ID of the account owning a VLAN", + "description": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "guest vlan range to be dedicated", + "description": "list of scaleup autoscale policies", "length": 255, - "name": "vlanrange", - "required": true, - "type": "string" + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": false, + "type": "list" }, { - "description": "physical network ID of the vlan", + "description": "the frequency in which the performance counters to be collected", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "interval", + "required": false, + "type": "integer" + }, + { + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "length": 255, + "name": "maxmembers", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the autoscale group", + "length": 255, + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "required": true, "type": "uuid" }, { - "description": "account who will own the VLAN", + "description": "list of scaledown autoscale policies", "length": 255, - "name": "account", + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, - "type": "string" + "type": "list" }, { - "description": "project who will own the VLAN", + "description": "the name of the autoscale vmgroup", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "name", "required": false, - "type": "uuid" - } - ], - "related": "listDedicatedGuestVlanRanges", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "since": "4.18.0", "type": "string" }, - {}, { - "description": "the account of the guest VLAN range", - "name": "account", + "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": "the zone of the guest vlan range", - "name": "zoneid", - "type": "long" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "length": 255, + "name": "minmembers", + "required": false, + "type": "integer" + } + ], + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "response": [ + { + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the project name of the guest vlan range", - "name": "project", + "description": "the domain ID of the vm 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 guest network the lb rule belongs to", + "name": "associatednetworkname", + "type": "string" }, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, + {}, { - "description": "the project id of the guest vlan range", - "name": "projectid", + "description": "the private port", + "name": "privateport", "type": "string" }, + {}, { - "description": "the ID of the guest VLAN range", + "description": "the autoscale vm group ID", "name": "id", "type": "string" }, { - "description": "the domain name of the guest VLAN range", - "name": "domain", - "type": "string" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, - {}, - { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", - "type": "long" - } - ] - }, - { - "description": "Adds VM to specified network by creating a NIC", - "isasync": true, - "name": "addNicToVirtualMachine", - "params": [ { - "description": "Network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Mac Address for the new network", - "length": 255, - "name": "macaddress", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "IP Address for the new network", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "Virtual Machine ID", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", - "length": 255, - "name": "dhcpoptions", - "required": false, - "type": "map" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" + }, { - "description": "the list of resource tags associated", - "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", + "description": "the project name of the vm group", + "name": "project", + "type": "string" + }, + { + "description": "the date when this vm group was created", + "name": "created", + "type": "date" + }, + { + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", "type": "list" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the domain name of the vm group", + "name": "domain", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the current state of the AutoScale Vm Group", + "name": "state", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the public port", + "name": "publicport", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the account owning the vm group", + "name": "account", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the name of the autoscale vm group ", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "Deletes a snapshot of a disk volume.", + "isasync": true, + "name": "deleteSnapshot", + "params": [ + { + "description": "The ID of the snapshot", + "length": 255, + "name": "id", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", + "required": true, + "type": "uuid" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "The ID of the zone for the snapshot", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.19.0", + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "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": "List the virtual machines owned by the account.", + "isasync": false, + "name": "listVirtualMachines", + "params": [ + { + "description": "the instances by userdata", + "length": 255, + "name": "userdataid", + "related": "listCniConfiguration", + "required": false, + "since": "4.20.1", + "type": "uuid" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the IDs of the virtual machines, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": false, + "since": "4.4", + "type": "list" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "since": "4.16.0", + "type": "uuid" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "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": "the name of userdata used for the VM", - "name": "userdataname", + "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": "the password (if exists) of the virtual machine", - "name": "password", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", + "length": 255, + "name": "details", + "required": false, + "type": "list" }, { - "description": "the project name of the vm", - "name": "project", + "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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "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": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "list by the backup offering", + "length": 255, + "name": "backupofferingid", + "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the availability zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "length": 255, + "name": "accumulate", + "required": false, + "since": "4.17.0", + "type": "boolean" + }, + { + "description": "CPU arch of the VM", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20.1", "type": "string" }, - {}, { - "description": "the hypervisor on which the template runs", + "description": "The ID of the Orchestrator extension for the VM", + "length": 255, + "name": "extensionid", + "related": "createExtension,listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "the security group ID", + "length": 255, + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", + "required": false, + "since": "4.15", + "type": "uuid" + }, + { + "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": "Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.", + "length": 255, + "name": "gpuenabled", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "list vms by template", + "length": 255, + "name": "templateid", + "related": "prepareTemplate,listIsos,registerIso,updateIso,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 network type; true if need to list vms using Virtual Network, false otherwise", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "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 target hypervisor for the template", + "length": 255, "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the pod ID", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the host ID", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "flag to display the resource icon for VMs", + "length": 255, + "name": "showicon", + "required": false, + "since": "4.16.0.0", + "type": "boolean" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "list vms by vpc", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "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": "true if high-availability is enabled, false otherwise", + "description": "the storage ID where vm's volumes belong to", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "list vms by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "list vms by iso", + "length": 255, + "name": "isoid", + "required": false, + "type": "uuid" + }, + { + "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 group ID of the virtual machine", + "description": "the ID of AutoScaling VM Group", + "length": 255, + "name": "autoscalevmgroupid", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "required": false, + "since": "4.18.0", + "type": "uuid" + }, + { + "description": "the group ID", + "length": 255, "name": "groupid", - "type": "string" + "related": "createInstanceGroup,updateInstanceGroup", + "required": false, + "type": "uuid" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "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": "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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "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" - } - ], - "type": "set" + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the virtual machine", + "length": 255, + "name": "id", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "list by the service offering", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "Whether to return only leased instances", + "length": 255, + "name": "leased", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "list vms by ssh keypair name", + "length": 255, + "name": "keypair", + "required": false, + "type": "string" + } + ], + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "response": [ + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + {}, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "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": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { @@ -43038,38 +42683,55 @@ var preCache = `{ "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, + {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, + {}, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -43078,19 +42740,19 @@ var preCache = `{ "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "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", @@ -43098,13 +42760,58 @@ var preCache = `{ "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { @@ -43112,24 +42819,59 @@ var preCache = `{ "name": "securitygroup", "response": [ { - "description": "the project id of the group", - "name": "projectid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "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 ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", @@ -43140,68 +42882,53 @@ var preCache = `{ "name": "ruleid", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -43210,53 +42937,95 @@ var preCache = `{ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" }, { - "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", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "security group name", - "name": "securitygroupname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "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 list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -43264,8 +43033,8 @@ var preCache = `{ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -43274,28 +43043,33 @@ var preCache = `{ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -43304,28 +43078,33 @@ var preCache = `{ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", @@ -43335,6 +43114,21 @@ var preCache = `{ "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" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" } ], "type": "set" @@ -43344,30 +43138,15 @@ var preCache = `{ "name": "project", "type": "string" }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, { "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 name of the security group", - "name": "name", - "type": "string" - }, - { - "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 ID of the security group", @@ -43375,74 +43154,27 @@ var preCache = `{ "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "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" - } - ], - "type": "set" + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" } ], "type": "set" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { "description": "an optional field whether to the display the vm to the end user or not.", @@ -43450,23 +43182,125 @@ var preCache = `{ "type": "boolean" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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": "tag key name", + "name": "key", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { @@ -43475,34 +43309,38 @@ var preCache = `{ "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, - {}, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "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" }, { @@ -43511,57 +43349,52 @@ var preCache = `{ "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -43570,8 +43403,8 @@ var preCache = `{ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -43580,8 +43413,8 @@ var preCache = `{ "type": "boolean" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -43590,8 +43423,8 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -43605,13 +43438,38 @@ var preCache = `{ "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -43620,8 +43478,33 @@ var preCache = `{ "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -43630,19 +43513,24 @@ var preCache = `{ "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { "description": "the cidr of IPv6 network", @@ -43650,326 +43538,261 @@ var preCache = `{ "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + } + ], + "type": "set" + }, + { + "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" } ], "type": "set" }, - {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - } - ] - }, - { - "description": "Lists all static routes", - "isasync": false, - "name": "listStaticRoutes", - "params": [ - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "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 write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "list static route by id", - "length": 255, - "name": "id", - "related": "listStaticRoutes", - "required": false, - "type": "uuid" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "list static routes by vpc id", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "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, + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "list static routes by gateway id", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", - "required": false, - "type": "uuid" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "list static routes by state", - "length": 255, - "name": "state", - "required": false, + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the domain associated with the static route", - "name": "domain", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the list of resource tags associated with static route", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "list" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the ID of the domain associated with the static route", - "name": "domainid", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "static route CIDR", - "name": "cidr", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, - {}, { - "description": "the project name of the static route", - "name": "project", - "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": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, - {}, { - "description": "the project id of the static route", - "name": "projectid", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the state of the static route", - "name": "state", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the account associated with the static route", - "name": "account", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ID of static route", - "name": "id", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" } ] }, { - "description": "Lists all public ip addresses", + "description": "Lists all available disk offerings.", "isasync": false, - "name": "listPublicIpAddresses", + "name": "listDiskOfferings", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the virtual network for the IP address", - "length": 255, - "name": "forvirtualnetwork", - "required": false, - "type": "boolean" - }, - { - "description": "lists all public IP addresses by physical network ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "lists all public IP addresses by source network ID", + "description": "ID of the disk offering", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "createDiskOffering,listDiskOfferings", "required": false, - "since": "4.13.0", "type": "uuid" }, { @@ -43980,69 +43803,66 @@ var preCache = `{ "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "lists the specified IP address", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "ipaddress", + "name": "account", "required": false, "type": "string" }, { - "description": "list only static NAT IP addresses", + "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", "length": 255, - "name": "isstaticnat", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "boolean" + "since": "4.17", + "type": "uuid" }, { - "description": "list only source NAT IP addresses", + "description": "listed offerings support disk encryption", "length": 255, - "name": "issourcenat", + "name": "encrypt", "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", "length": 255, - "name": "account", + "name": "state", "required": false, + "since": "4.19", "type": "string" }, { - "description": "list only IPs used for load balancing", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "forloadbalancing", + "name": "storagetype", "required": false, - "type": "boolean" + "since": "4.19", + "type": "string" }, { - "description": "makes the API's response contains only the resource count", + "description": "name of the disk offering", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "lists all public IP addresses by VLAN ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "vlanid", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -44052,560 +43872,396 @@ var preCache = `{ "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "lists all public IP addresses by state", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "lists all public IP addresses associated to the network specified", - "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "limits search results to allocated public IP addresses", - "length": 255, - "name": "allocatedonly", - "required": false, - "type": "boolean" - }, - { - "description": "lists IP address by ID", + "description": "The ID of a virtual machine. Pass this in if you want to see the suitable disk offering that can be used to create and add a disk to the virtual machine. Suitability is returned with suitableforvirtualmachine flag in the response", "length": 255, - "name": "id", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": false, + "since": "4.20.0", "type": "uuid" }, { - "description": "lists all public IP addresses by zone ID", + "description": "id of zone disk offering is associated with", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, + "since": "4.13", "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "List IPs belonging to the VPC", + "description": "The ID of the volume, tags of the volume are used to filter the offerings", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, + "since": "4.17", "type": "uuid" } ], - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "related": "createDiskOffering", "response": [ { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "state of the disk offering", + "name": "state", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "public IP address id", - "name": "id", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, - {}, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of resource tags associated with ip address", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "an alternate display text of the disk offering.", + "name": "displaytext", + "type": "string" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", - "type": "string" + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", - "type": "string" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "the account the public IP address is associated with", - "name": "account", - "type": "string" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, + {}, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", - "type": "string" + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", + "type": "boolean" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", - "type": "string" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" - } - ] - }, - { - "description": "Updates an ISO file.", - "isasync": false, - "name": "updateIso", - "params": [ + }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the ID of the image file", - "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", - "length": 255, - "name": "bootable", - "required": false, + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", "type": "boolean" }, { - "description": "the name of the image file", - "length": 255, + "description": "the name of the disk offering", "name": "name", - "required": false, "type": "string" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + } + ] + }, + { + "description": "Deletes a Cisco ASA 1000v appliance", + "isasync": false, + "name": "deleteCiscoAsa1000vResource", + "params": [ + { + "description": "Cisco ASA 1000v resource ID", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", + "required": true, "type": "uuid" - }, + } + ], + "response": [ { - "description": "sort key of the template, integer", - "length": 255, - "name": "sortkey", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", - "length": 255, - "name": "cleanupdetails", - "required": false, - "type": "boolean" - }, - { - "description": "true if the template type is routing i.e., if template is used to deploy router", - "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" - }, - { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if the image supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "the display text of the image", - "length": 4096, + "description": "any text associated with the success or failure", "name": "displaytext", - "required": false, "type": "string" - }, + } + ] + }, + { + "description": "Upgrades a running CloudManaged Kubernetes cluster", + "isasync": true, + "name": "upgradeKubernetesCluster", + "params": [ { - "description": "the format for the image", + "description": "the ID of the Kubernetes version for upgrade", "length": 255, - "name": "format", - "required": false, - "type": "string" + "name": "kubernetesversionid", + "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "required": true, + "type": "uuid" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" } ], - "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", "response": [ { - "description": "the account name to which the template belongs", - "name": "account", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, - {}, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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" - } - ], - "type": "set" + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", + "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, {}, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the name of the Kubernetes cluster", + "name": "name", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -44613,29 +44269,64 @@ var preCache = `{ "type": "integer" }, { - "description": "the date this template was created", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" + }, + { + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", + "type": "string" + }, + { + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" + }, + { + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" + }, + { + "description": "the date when this Kubernetes cluster was created", "name": "created", "type": "date" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, + { + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", + "type": "string" + }, + { + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -44643,959 +44334,838 @@ var preCache = `{ "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, + { + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, + { + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "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", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, + {}, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" + } + ] + }, + { + "description": "Creates a condition for VM auto scaling", + "isasync": true, + "name": "createCondition", + "params": [ + { + "description": "ID of the Counter.", + "length": 255, + "name": "counterid", + "related": "createCounter,listCounters", + "required": true, + "type": "uuid" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the domain ID of the account.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "Value for which the Counter will be evaluated with the Operator selected.", + "length": 255, + "name": "threshold", + "required": true, "type": "long" }, { - "description": "the template name", - "name": "name", + "description": "the account of the condition. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "length": 255, + "name": "relationaloperator", + "required": true, + "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, + "description": "an optional project for condition", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + } + ], + "related": "listConditions", + "response": [ { - "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 domain id of the Condition owner", + "name": "domainid", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the domain name of the owner.", + "name": "domain", + "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "path of the domain to which the Condition owner belongs", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the Id of the Counter.", + "name": "counterid", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the project name of the Condition", + "name": "project", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, { - "description": "the size of the template", - "name": "size", + "description": "Threshold Value for the counter.", + "name": "threshold", "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" }, + {}, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the id of the Condition", + "name": "id", + "type": "string" }, + {}, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the Name of the Counter.", + "name": "countername", + "type": "string" + }, + { + "description": "the owner of the Condition.", + "name": "account", "type": "string" } ] }, { - "description": "Lists OpenDyalight controllers", + "description": "Lists projects and provides detailed information for listed projects", "isasync": false, - "name": "listOpenDaylightControllers", + "name": "listProjects", "params": [ { - "description": "the ID of a OpenDaylight Controller", + "description": "flag to display the resource icon for projects", "length": 255, - "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "pagesize", "required": false, - "type": "uuid" - } - ], - "related": "addOpenDaylightController,deleteOpenDaylightController", - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", "type": "integer" }, { - "description": "the url of the controller api", - "name": "url", + "description": "list projects by display text", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "device id of the controller", - "name": "id", - "type": "string" + "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 physical network to which this controller belongs to", - "name": "physicalnetworkid", - "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" }, { - "description": "the username to authenticate to the controller", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List projects by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "List projects by username", + "length": 255, "name": "username", + "required": false, "type": "string" }, { - "description": "the name assigned to the controller", + "description": "list projects by name", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Adds a BigSwitch BCF Controller device", - "isasync": true, - "name": "addBigSwitchBcfDevice", - "params": [ - { - "description": "Hostname of ip address of the BigSwitch BCF Controller.", + "description": "list projects by project ID", "length": 255, - "name": "hostname", - "required": true, - "type": "string" + "name": "id", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "Username of the BigSwitch BCF Controller.", + "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "details", + "required": false, + "type": "list" }, { - "description": "the Physical Network ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, "type": "uuid" }, { - "description": "NAT support of the BigSwitch BCF Controller.", + "description": "List by keyword", "length": 255, - "name": "nat", - "required": true, - "type": "boolean" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "Password of the BigSwitch BCF Controller.", + "description": "list projects by state", "length": 255, - "name": "password", - "required": true, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" } ], - "related": "listBigSwitchBcfDevices", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the controller username", - "name": "username", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "NAT support", - "name": "nat", - "type": "boolean" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "device name", - "name": "bigswitchdevicename", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the controller password", - "name": "password", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of gpus the project can own", + "name": "gpulimit", + "type": "string" }, - {} - ], - "since": "4.6.0" - }, - { - "description": "Deletes a counter for VM auto scaling", - "isasync": true, - "name": "deleteCounter", - "params": [ { - "description": "the ID of the counter", - "length": 255, - "name": "id", - "related": "createCounter,listCounters", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, - {} - ] - }, - { - "description": "Changes the default NIC on a VM", - "isasync": true, - "name": "updateDefaultNicForVirtualMachine", - "params": [ { - "description": "NIC ID", - "length": 255, - "name": "nicid", - "related": "", - "required": true, - "type": "uuid" + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" }, { - "description": "Virtual Machine ID", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "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 total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "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 project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, - {}, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", "type": "list" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, + {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of backups available to this project", + "name": "backupavailable", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the id of the project", + "name": "id", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "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" - }, - { - "description": "tag value", - "name": "value", - "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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "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 project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "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": "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - } - ], - "type": "set" + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Creates an account", + "isasync": false, + "name": "createAccount", + "params": [ + { + "description": "Account UUID, required for adding account from external provisioning system", + "length": 255, + "name": "accountid", + "required": false, + "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "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": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "required": false, "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "details for account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" + }, + { + "description": "Creates the user under the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "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": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "lastname", + "length": 255, + "name": "lastname", + "required": true, + "type": "string" }, - {}, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Network domain for the account's networks", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "firstname", + "length": 255, + "name": "firstname", + "required": true, "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "email", + "length": 255, + "name": "email", + "required": true, + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "Unique username.", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "length": 255, + "name": "password", + "required": true, + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Creates the account under the specified role.", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": false, + "type": "uuid" + } + ], + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "response": [ + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { @@ -45604,1818 +45174,1836 @@ var preCache = `{ "type": "integer" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - } - ], - "type": "set" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the state of the account", + "name": "state", "type": "string" }, + {}, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" } ], - "type": "set" + "type": "list" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - } - ] - }, - { - "description": "Generate DRS plan for a cluster", - "isasync": false, - "name": "generateClusterDrsPlan", - "params": [ + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, { - "description": "the ID of the Cluster", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting", - "length": 255, - "name": "migrations", - "required": false, - "type": "integer" - } - ], - "related": "executeClusterDrsPlan", - "response": [ + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "Id of the cluster", - "name": "clusterid", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", + "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "List of migrations", - "name": "migrations", - "type": "list" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "unique ID of the drs plan for cluster", - "name": "id", + "description": "id of the Domain the account belongs to", + "name": "domainid", "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": "Start event Id of the DRS Plan", - "name": "eventid", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, - {} - ], - "since": "4.19.0" - }, - { - "description": "Deletes a user for an account", - "isasync": false, - "name": "deleteUser", - "params": [ - { - "description": "id of the user to be deleted", - "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, - "type": "uuid" - } - ], - "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "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 account", + "name": "vmtotal", + "type": "long" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Initiates the specified power action to the host's out-of-band management interface", - "isasync": true, - "name": "issueOutOfBandManagementPowerAction", - "params": [ + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, { - "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", - "length": 255, - "name": "action", - "required": true, + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, { - "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", - "length": 255, - "name": "timeout", - "required": false, - "type": "long" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster", - "response": [ + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" }, - {}, - {}, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" } - ], - "since": "4.9.0" + ] }, { - "description": "Issues a client certificate using configured or provided CA plugin", + "description": "Revert VM from a vmsnapshot.", "isasync": true, - "name": "issueCertificate", + "name": "revertToVMSnapshot", "params": [ { - "description": "Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN", - "length": 255, - "name": "domain", - "required": false, - "type": "string" - }, - { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "description": "The ID of the vm snapshot", "length": 255, - "name": "provider", - "required": false, - "type": "string" - }, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": true, + "type": "uuid" + } + ], + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "response": [ { - "description": "Comma separated list of IP addresses, the certificate should be issued for", - "length": 255, + "description": "the VM's primary IP address", "name": "ipaddress", - "required": false, "type": "string" }, { - "description": "Certificate validity duration in number of days, when not provided the default configured value will be used", - "length": 255, - "name": "duration", - "required": false, - "type": "integer" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered", - "length": 65535, - "name": "csr", - "required": false, - "type": "string" - } - ], - "related": "listCaCertificate", - "response": [ - {}, - { - "description": "Private key for the certificate", - "name": "privatekey", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "The CA certificate(s)", - "name": "cacertificates", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "The client certificate", - "name": "certificate", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, - {} - ], - "since": "4.11.0" - }, - { - "description": "Deletes network device.", - "isasync": false, - "name": "deleteNetworkDevice", - "params": [ { - "description": "Id of network device to delete", - "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "Updates image store read-only status", - "isasync": false, - "name": "updateImageStore", - "params": [ { - "description": "Image Store UUID", - "length": 255, - "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", - "length": 255, - "name": "readonly", - "required": true, - "type": "boolean" - } - ], - "related": "addSecondaryStorage,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "response": [ + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, + {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "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 Zone name of the image store", - "name": "zonename", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, + {}, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the url of the image store", - "name": "url", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" + "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 ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "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 project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + } + ], + "type": "set" }, - {}, - { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - } - ], - "since": "4.15.0" - }, - { - "description": "Creates a port forwarding rule", - "isasync": true, - "name": "createPortForwardingRule", - "params": [ { - "description": "the starting port of port forwarding rule's public port range", - "length": 255, - "name": "publicport", - "required": true, - "type": "integer" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "VM guest nic secondary IP address for the port forwarding rule", - "length": 255, - "name": "vmguestip", - "required": false, + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "length": 255, - "name": "publicendport", - "required": false, - "type": "integer" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "length": 255, - "name": "privateendport", - "required": false, - "type": "integer" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true", - "length": 255, - "name": "openfirewall", - "required": false, + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "the ID of the virtual machine for the port forwarding rule", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the IP address id of the port forwarding rule", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "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" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the starting port of port forwarding rule's private port range", - "length": 255, - "name": "privateport", - "required": true, - "type": "integer" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - } - ], - "related": "listPortForwardingRules,updatePortForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", - "response": [ - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, - {}, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "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": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project id the tag belongs to", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "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" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain name of the security group", "name": "domain", "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], - "type": "list" + "type": "set" }, - {}, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" - } - ] - }, - { - "description": "load template into primary storage", - "isasync": false, - "name": "prepareTemplate", - "params": [ - { - "description": "zone ID of the template to be prepared in primary storage(s).", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools.", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" }, { - "description": "template ID of the template to be prepared in primary storage(s).", - "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - } - ], - "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - {}, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "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 tag of this template", - "name": "templatetag", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - {}, - { - "description": "the type of the template", - "name": "templatetype", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, + {}, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "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 status of the template", - "name": "status", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the date this template was created", + "description": "the date when this virtual machine was created", "name": "created", "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the group ID of the virtual machine", + "name": "groupid", "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", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "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": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" } ], "type": "set" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the project name of the template", - "name": "project", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "checksum of the template", - "name": "checksum", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" - } - ] - }, - { - "description": "Dedicates a zones.", - "isasync": true, - "name": "dedicateZone", - "params": [ - { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" }, { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Name of the Zone", - "name": "zonename", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, - {}, - {}, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "Assigns virtual machine or a list of virtual machines to a load balancer rule.", + "description": "Removes a Guest OS Mapping.", "isasync": true, - "name": "assignToLoadBalancerRule", + "name": "removeGuestOsMapping", "params": [ { - "description": "the ID of the load balancer rule", + "description": "ID of the guest OS mapping", "length": 255, "name": "id", - "related": "listPortForwardingRules,updatePortForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", + "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", "required": true, "type": "uuid" - }, - { - "description": "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)", - "length": 255, - "name": "virtualmachineids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "list" - }, - { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", - "length": 255, - "name": "vmidipmap", - "required": false, - "since": "4.4", - "type": "map" } ], "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } - ] - }, - { - "description": "Lists all pending asynchronous jobs for the account.", - "isasync": false, - "name": "listAsyncJobs", - "params": [ - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ], + "since": "4.4.0" + }, + { + "description": "create Tungsten-Fabric service group", + "isasync": true, + "name": "createTungstenFabricServiceGroup", + "params": [ { - "description": "", + "description": "Tungsten-Fabric service group end port", "length": 255, - "name": "pagesize", - "required": false, + "name": "endport", + "required": true, "type": "integer" }, { - "description": "", + "description": "Tungsten-Fabric service group start port", "length": 255, - "name": "page", - "required": false, + "name": "startport", + "required": true, "type": "integer" }, { - "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", + "description": "the ID of zone", "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "List by keyword", + "description": "Tungsten-Fabric service group protocol", "length": 255, - "name": "keyword", - "required": false, + "name": "protocol", + "required": true, "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" - }, - { - "description": "The id of the management server", - "length": 255, - "name": "managementserverid", - "related": "listManagementServers", - "required": false, - "since": "4.19", - "type": "uuid" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "Tungsten-Fabric service group name", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" } ], - "related": "queryAsyncJobResult", + "related": "", "response": [ { - "description": "the user that executed the async command", - "name": "userid", - "type": "string" - }, - { - "description": " the completed date of the job", - "name": "completed", - "type": "date" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the account that executed the async command", - "name": "account", + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", "type": "string" }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" - }, - { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "Tungsten-Fabric service group name", + "name": "name", + "type": "string" }, { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", - "type": "long" + "description": "Tungsten-Fabric service group protocol", + "name": "protocol", + "type": "string" }, - {}, { - "description": "the result code for the job", - "name": "jobresultcode", - "type": "integer" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the domain that executed the async command", - "name": "domainpath", - "type": "string" - }, + {}, {}, { - "description": "the result type", - "name": "jobresulttype", - "type": "string" - }, - { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", - "type": "string" - }, - { - "description": "the current job status-should be 0 for PENDING", + "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain id that executed the async command", - "name": "domainid", - "type": "string" - }, - { - "description": "the async command executed", - "name": "cmd", - "type": "string" - }, - { - "description": " the created date of the job", - "name": "created", - "type": "date" - }, - { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", - "type": "string" - }, - { - "description": "the account id that executed the async command", - "name": "accountid", - "type": "string" + "description": "Tungsten-Fabric service group end port", + "name": "endport", + "type": "int" } ] }, { - "description": "Archive one or more alerts.", + "description": "Recover a Shared FileSystem by id", "isasync": false, - "name": "archiveAlerts", + "name": "recoverSharedFileSystem", "params": [ { - "description": "start date range to archive alerts (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": "end date range to archive alerts (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": "the IDs of the alerts", - "length": 255, - "name": "ids", - "related": "listAlerts", - "required": false, - "type": "list" - }, - { - "description": "archive by alert type", + "description": "the ID of the shared filesystem to recover", "length": 255, - "name": "type", + "name": "id", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "required": false, - "type": "string" + "type": "uuid" } ], "response": [ @@ -47424,176 +47012,177 @@ var preCache = `{ "name": "success", "type": "boolean" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } - ] + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ], + "since": "4.20.0" }, { - "description": "Lists all Buckets.", + "description": "Registers an existing ISO into the CloudStack Cloud.", "isasync": false, - "name": "listBuckets", + "name": "registerIso", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "account", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the URL to where the ISO is currently being hosted", + "length": 2048, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "tags", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the IDs of the Buckets, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "listBuckets", + "description": "the display text of the ISO, defaults to the 'name'", + "length": 4096, + "name": "displaytext", "required": false, - "type": "list" + "type": "string" }, { - "description": "", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "pagesize", + "name": "bootable", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List by keyword", + "description": "the name of the ISO", "length": 255, - "name": "keyword", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "isrecursive", + "name": "checksum", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", "length": 255, - "name": "listall", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "ostypeid", + "related": "addGuestOs", "required": false, "type": "uuid" }, { - "description": "the name of the bucket", + "description": "the ID of the zone you wish to register the ISO to.", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the ID of the object storage pool, available to ROOT admin only", + "description": "an optional account name. Must be used with domainId.", "length": 255, - "name": "objectstorageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "isextractable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the bucket", + "description": "true if password reset feature is supported; default is false", "length": 255, - "name": "id", - "related": "listBuckets", + "name": "passwordenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "page", + "name": "ispublic", "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "the account associated with the Bucket", - "name": "account", - "type": "string" - }, - { - "description": "State of the Bucket", - "name": "state", - "type": "string" - }, - { - "description": "the domain associated with the bucket", - "name": "domain", - "type": "string" + "type": "boolean" }, { - "description": "Bucket Encryption", - "name": "encryption", + "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "length": 255, + "name": "directdownload", + "required": false, "type": "boolean" }, { - "description": "Bucket Object Locking", - "name": "objectlocking", - "type": "boolean" + "description": "Register ISO for the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" + "description": "true if you want this ISO to be featured", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" }, { - "description": "Bucket Access Key", - "name": "accesskey", + "description": "Image store UUID", + "length": 255, + "name": "imagestoreuuid", + "required": false, "type": "string" - }, + } + ], + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ { - "description": "Bucket Quota in GB", - "name": "quota", - "type": "integer" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -47607,13 +47196,8 @@ var preCache = `{ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -47622,13 +47206,13 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -47640,269 +47224,538 @@ var preCache = `{ "description": "the project id the tag belongs to", "name": "projectid", "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" } ], "type": "set" }, { - "description": "Bucket Versioning", - "name": "versioning", - "type": "boolean" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "ID of the Bucket", - "name": "id", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Bucket URL", - "name": "url", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "Bucket Access Policy", - "name": "policy", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, - {}, { - "description": "the project name of the bucket", - "name": "project", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "Bucket Secret Key", - "name": "usersecretkey", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the project id of the bucket", - "name": "projectid", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the date the Bucket was created", - "name": "created", - "type": "date" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "name of the Bucket", - "name": "name", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "id of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstorageid", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, + {}, { - "description": "Object storage provider", - "name": "provider", + "description": "the tag of this template", + "name": "templatetag", "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Deletes a Cisco Vnmc controller", - "isasync": false, - "name": "deleteCiscoVnmcResource", - "params": [ + }, { - "description": "Cisco Vnmc resource ID", - "length": 255, - "name": "resourceid", - "related": "listCiscoVnmcResources", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "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 operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Creates a secondary storage selector, described by the heuristic rule.", - "isasync": false, - "name": "createSecondaryStorageSelector", - "params": [ + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, { - "description": "The description of the heuristic rule.", - "length": 255, - "name": "description", - "required": true, - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "length": 255, - "name": "type", - "required": true, - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "The zone in which the heuristic rule will be applied.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "The name identifying the heuristic rule.", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; } would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", - "length": 65535, - "name": "heuristicrule", - "required": true, + "description": "the project name of the template", + "name": "project", "type": "string" - } - ], - "related": "updateSecondaryStorageSelector,removeSecondaryStorageSelector", - "response": [ + }, { - "description": "ID of the heuristic.", - "name": "id", - "type": "string" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "Description of the heuristic.", - "name": "description", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, - {}, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, + {}, { - "description": "When the heuristic was created.", + "description": "the date this template was created", "name": "created", "type": "date" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "Name of the heuristic.", - "name": "name", + "description": "the template display text", + "name": "displaytext", "type": "string" - } + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + {}, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + } + ] + }, + { + "description": "Lists Cisco ASA 1000v appliances", + "isasync": false, + "name": "listCiscoAsa1000vResources", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "Cisco ASA 1000v resource ID", + "length": 255, + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } ], - "since": "4.19.0" + "related": "addCiscoAsa1000vResource", + "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": "Stops an Internal LB vm.", + "description": "deletes a range of portable public IP's associated with a region", "isasync": true, - "name": "stopInternalLoadBalancerVM", + "name": "deletePortableIpRange", "params": [ { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "description": "Id of the portable ip range", "length": 255, - "name": "forced", - "required": false, + "name": "id", + "related": "createPortableIpRange", + "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": "the ID of the internal lb vm", + "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": "Upgrades router to use newer template", + "isasync": false, + "name": "upgradeRouterTemplate", + "params": [ + { + "description": "upgrades router with the specified Id", "length": 255, "name": "id", - "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "required": true, + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": false, + "type": "uuid" + }, + { + "description": "upgrades all routers owned by the specified domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "upgrades all routers owned by the specified account", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "upgrades all routers within the specified pod", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "upgrades all routers within the specified zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "upgrades all routers within the specified cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, "type": "uuid" } ], - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "related": "", "response": [ { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} + ] + }, + { + "description": "Cancels host maintenance.", + "isasync": true, + "name": "cancelHostMaintenance", + "params": [ + { + "description": "the host ID", + "length": 255, + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "response": [ + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { @@ -47911,1497 +47764,1397 @@ var preCache = `{ "type": "boolean" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "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 public IP address for the router", - "name": "publicip", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" + }, + { + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the date and time the router was created", + "description": "the date and time the host was created", "name": "created", "type": "date" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "type": "boolean" }, + {}, { - "description": "the template ID for the router", - "name": "templateid", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "GPU cards present in the host", + "name": "gpugroup", "response": [ { - "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": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "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 Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + } + ], "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "GPU cards present in the host", + "name": "gpugroupname", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, - {}, { - "description": "the version of template", - "name": "version", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "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 OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, + {}, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - } - ], - "type": "list" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, - {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + {}, + { + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" + }, + { + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" } ] }, { - "description": "Adds a Brocade VCS Switch", - "isasync": true, - "name": "addBrocadeVcsDevice", + "description": "Lists all VLAN IP ranges.", + "isasync": false, + "name": "listVlanIpRanges", "params": [ { - "description": "the Physical Network ID", + "description": "physical network id of the VLAN IP range", "length": 255, "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, "type": "uuid" }, { - "description": "Credentials to access the Brocade VCS Switch API", + "description": "project who will own the VLAN", "length": 255, - "name": "password", - "required": true, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "Hostname of ip address of the Brocade VCS Switch.", + "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", "length": 255, - "name": "hostname", - "required": true, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "Credentials to access the Brocade VCS Switch API", + "description": "the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.", "length": 255, - "name": "username", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "the Zone ID of the VLAN IP range", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the Pod ID of the VLAN IP range", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "true if VLAN is of Virtual type, false if Direct", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the VLAN IP range", + "length": 255, + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "required": false, + "type": "uuid" + }, + { + "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": "network id of the VLAN IP range", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" } ], - "related": "listBrocadeVcsDevices", + "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", "response": [ { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, + { + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "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": "name of the provider", + "description": "indicates to which provider the IP range is dedicated to", "name": "provider", "type": "string" }, { - "description": "device name", - "name": "brocadedevicename", + "description": "the domain name of the VLAN IP range", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the vlan range", + "name": "project", + "type": "string" + }, + { + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", + "type": "string" + }, + { + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, - {}, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the description of the VLAN IP range", + "name": "description", + "type": "string" }, { - "description": "the principal switch Ip address", - "name": "hostname", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" - } - ] - }, - { - "description": "Updates a security group", - "isasync": false, - "name": "updateSecurityGroup", - "params": [ + }, { - "description": "The new name of the security group.", - "length": 255, - "name": "name", - "required": false, + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "The ID of the security group.", - "length": 255, - "name": "id", - "related": "createSecurityGroup,updateSecurityGroup", - "required": true, - "type": "uuid" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "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", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" - } - ], - "related": "createSecurityGroup", - "response": [ - {}, + }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "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 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": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "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": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project id of the group", - "name": "projectid", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], - "type": "set" - }, - {}, - { - "description": "the domain name of the security group", - "name": "domain", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the project id of the vlan range", + "name": "projectid", + "type": "string" }, + {}, { - "description": "the name of the security group", - "name": "name", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the network id of vlan range", + "name": "networkid", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" } - ], - "since": "4.14.0.0" + ] }, { - "description": "Creates a domain", + "description": "Updates a Zone.", "isasync": false, - "name": "createDomain", + "name": "updateZone", "params": [ { - "description": "Domain UUID, required for adding domain from another Region", + "description": "the first DNS for the Zone", "length": 255, - "name": "domainid", + "name": "dns1", "required": false, "type": "string" }, { - "description": "assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.", + "description": "updates a private zone to public if set, but not vice-versa", "length": 255, - "name": "parentdomainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "ispublic", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Network domain for networks in the domain", + "description": "the details for the Zone", "length": 255, - "name": "networkdomain", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "creates domain with this name", + "description": "the dhcp Provider for the Zone", "length": 255, - "name": "name", - "required": true, + "name": "dhcpprovider", + "required": false, "type": "string" - } - ], - "related": "listDomainChildren,listDomains,listDomains", - "response": [ + }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the first internal DNS for the Zone", + "length": 255, + "name": "internaldns1", + "required": false, "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the guest CIDR address for the Zone", + "length": 255, + "name": "guestcidraddress", + "required": false, "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "sort key of the zone, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", + "length": 255, + "name": "domain", + "required": false, "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" + "description": "the dns search order list", + "length": 255, + "name": "dnssearchorder", + "required": false, + "type": "list" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the second DNS for the Zone", + "length": 255, + "name": "dns2", + "required": false, + "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the second DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns2", + "required": false, + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if local storage offering enabled, false otherwise", + "length": 255, + "name": "localstorageenabled", + "required": false, "type": "boolean" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the ID of the domain", + "description": "the ID of the Zone", + "length": 255, "name": "id", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the name of the Zone", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the second internal DNS for the Zone", + "length": 255, + "name": "internaldns2", + "required": false, "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the first DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns1", + "required": false, "type": "string" - }, + } + ], + "related": "createZone,listZones,listZones", + "response": [ { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the list of resource tags associated with zone.", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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 path of the domain", - "name": "path", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" + "description": "the capacity of the Zone", + "name": "capacity", + "response": [ + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + } + ], + "type": "list" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", - "type": "string" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "External network provider if any", + "name": "provider", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" }, {}, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" + }, + { + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "Total GPUs in the Zone", + "name": "gputotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" + }, + { + "description": "Used GPUs in the Zone", + "name": "gpuused", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, - {}, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the first DNS for the Zone", + "name": "dns1", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "type": "string" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "true, if routed network/vpc is enabled", + "name": "routedmodeenabled", + "type": "boolean" + }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the display text of the zone", + "name": "displaytext", + "type": "string" } ] }, { - "description": "Deleting resource tag(s)", + "description": "Extracts volume", "isasync": true, - "name": "deleteTags", + "name": "extractVolume", "params": [ { - "description": "Delete tag by resource type", + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", "length": 255, - "name": "resourcetype", + "name": "mode", "required": true, "type": "string" }, { - "description": "Delete tags for resource id(s)", + "description": "the ID of the volume", "length": 255, - "name": "resourceids", + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": true, - "type": "list" + "type": "uuid" }, { - "description": "Delete tags matching key/value pairs", + "description": "the ID of the zone where the volume is located", "length": 255, - "name": "tags", + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the url to which the volume would be extracted", + "length": 2048, + "name": "url", "required": false, - "type": "map" + "type": "string" } ], + "related": "downloadImageStoreObject,extractIso,extractSnapshot,extractTemplate", "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ], - "since": "4.0.0" - }, - { - "description": "create Tungsten-Fabric tag type", - "isasync": true, - "name": "createTungstenFabricTagType", - "params": [ + }, { - "description": "the ID of zone", - "length": 255, + "description": "", + "name": "resultstring", + "type": "string" + }, + { + "description": "the state of the extracted object", + "name": "state", + "type": "string" + }, + { + "description": "zone ID the object was extracted from", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Tungsten-Fabric tag type name", - "length": 255, - "name": "name", - "required": true, + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" - } - ], - "related": "listTungstenFabricTagType", - "response": [ + }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the time and date the object was created", + "name": "created", + "type": "date" + }, + { + "description": "type of the storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" + }, + {}, {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the status of the extraction", + "name": "status", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the extracted object", + "name": "name", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { - "description": "Tungsten-Fabric tag type name", - "name": "name", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" } ] }, { - "description": "Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules", - "isasync": true, - "name": "restartNetwork", + "description": "Lists IPv4 subnets for guest networks.", + "isasync": false, + "name": "listIpv4SubnetsForGuestNetwork", "params": [ { - "description": "The ID of the network to restart.", + "description": "UUID of VPC to which the IPv4 subnet is associated to.", "length": 255, - "name": "id", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, "type": "uuid" }, { - "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "description": "List by keyword", "length": 255, - "name": "livepatch", + "name": "keyword", "required": false, - "since": "4.17.0", - "type": "boolean" + "type": "string" }, { - "description": "Turn the network into a network with redundant routers.", + "description": "", "length": 255, - "name": "makeredundant", + "name": "pagesize", "required": false, - "since": "4.11.1", - "type": "boolean" + "type": "integer" }, { - "description": "If cleanup old network elements", + "description": "", "length": 255, - "name": "cleanup", + "name": "page", "required": false, - "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" + "description": "UUID of the IPv4 subnet for guest network.", + "length": 255, + "name": "id", + "related": "createIpv4SubnetForGuestNetwork,listIpv4SubnetsForGuestNetwork", + "required": false, + "type": "uuid" }, - {} - ] - }, - { - "description": "Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the \"logout\" command has been issued or the session has expired.", - "isasync": false, - "name": "login", - "params": [ { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "description": "UUID of network to which the IPv4 subnet is associated to.", "length": 255, - "name": "domain", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", + "description": "The CIDR of the Ipv4 subnet.", "length": 255, - "name": "domainId", + "name": "subnet", "required": false, - "type": "long" + "type": "string" }, { - "description": "Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "description": "UUID of zone to which the IPv4 subnet belongs to.", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "Username", + "description": "UUID of zone Ipv4 subnet which the IPv4 subnet belongs to.", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "parentid", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "required": false, + "type": "uuid" } ], - "related": "", + "related": "createIpv4SubnetForGuestNetwork", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", - "type": "string" + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", + "type": "date" }, { - "description": "Username", - "name": "username", - "type": "string" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { - "description": "last name of the user", - "name": "lastname", - "type": "string" + "description": "date when this IPv4 subnet was removed.", + "name": "removed", + "type": "date" }, { - "description": "user time zone", - "name": "timezone", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", "type": "string" }, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", + "description": "id of the IPv4 subnet for guest network", + "name": "id", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "User ID", - "name": "userid", + "description": "subnet of the IPv4 network", + "name": "subnet", "type": "string" }, + {}, + {}, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "Name of the VPC which the IPv4 subnet is associated with.", + "name": "vpcname", "type": "string" }, { - "description": "Is two factor authentication verified", - "name": "is2faverified", + "description": "Id of the VPC which the IPv4 subnet is associated with.", + "name": "vpcid", "type": "string" }, { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" - }, - { - "description": "first name of the user", - "name": "firstname", + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" }, { - "description": "the account name the user belongs to", - "name": "account", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", + "description": "id of network which the IPv4 subnet is associated with.", + "name": "networkid", "type": "string" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Domain ID that the user belongs to", - "name": "domainid", + "description": "id of the data center IPv4 subnet", + "name": "parentid", "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "Lists all hypervisor capabilities.", + "description": "Lists project's accounts", "isasync": false, - "name": "listHypervisorCapabilities", + "name": "listProjectAccounts", "params": [ { "description": "", @@ -49411,19 +49164,27 @@ var preCache = `{ "type": "integer" }, { - "description": "ID of the hypervisor capability", + "description": "list accounts of the project by account name", "length": 255, - "name": "id", - "related": "listHypervisorCapabilities", + "name": "account", "required": false, + "type": "string" + }, + { + "description": "ID of the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "required": true, "type": "uuid" }, { - "description": "List by keyword", + "description": "list invitation by user ID", "length": 255, - "name": "keyword", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -49433,127 +49194,78 @@ var preCache = `{ "type": "integer" }, { - "description": "the hypervisor for which to restrict the search", + "description": "list accounts of the project by role", "length": 255, - "name": "hypervisor", + "name": "role", "required": false, "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "true if security group is supported", - "name": "securitygroupenabled", - "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list accounts of the project by project role id", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" }, - {}, - {}, { - "description": "the hypervisor type", - "name": "hypervisor", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, - { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" - }, + } + ], + "related": "activateProject,createProject,suspendProject,updateProject", + "response": [ { - "description": "the ID of the hypervisor capabilities row", - "name": "id", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the maximum number of guest vms recommended for this hypervisor", - "name": "maxguestslimit", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", - "type": "boolean" - }, - { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" - }, - { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", - "type": "boolean" - } - ], - "since": "3.0.0" - }, - { - "description": "Adds backup image store.", - "isasync": false, - "name": "addImageStore", - "params": [ - { - "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "the URL for the image store", - "length": 2048, - "name": "url", - "required": false, + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the Zone ID for the image store", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name for the image store", - "length": 255, - "name": "name", - "required": false, + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the image store provider name", - "length": 255, - "name": "provider", - "required": true, - "type": "string" - } - ], - "related": "addSecondaryStorage,listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "response": [ + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the total number of backups available to this project", + "name": "backupavailable", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { @@ -49562,1227 +49274,1045 @@ var preCache = `{ "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of gpus the project can own", + "name": "gpulimit", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "list" }, - {}, { - "description": "the ID of the image store", - "name": "id", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the total number of buckets available to this project", + "name": "bucketavailable", + "type": "string" }, - {}, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" }, { - "description": "the name of the image store", - "name": "name", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Revoke a direct download certificate from hosts in a zone", - "isasync": false, - "name": "revokeTemplateDirectDownloadCertificate", - "params": [ + }, { - "description": "(optional) alias of the SSL certificate", - "length": 255, - "name": "name", - "required": false, + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "id of the certificate", - "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", - "required": false, - "type": "uuid" + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" }, { - "description": "(optional) zone to revoke certificate", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "(optional) the host ID to revoke certificate", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" }, { - "description": "(optional) hypervisor type", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" - } - ], - "related": "provisionTemplateDirectDownloadCertificate", - "response": [ + }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, - {}, { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.13" - }, - { - "description": "Syncs capabilities of storage pools", - "isasync": false, - "name": "updateStorageCapabilities", - "params": [ - { - "description": "Storage pool id", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" - } - ], - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "response": [ - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the name of the project", + "name": "name", + "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", "type": "long" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, + {}, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, - {}, { - "description": "the name of the storage pool", - "name": "name", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" } ], - "since": "4.16.0" + "since": "3.0.0" }, { - "description": "Delete Project roles in CloudStack", - "isasync": false, - "name": "deleteProjectRole", + "description": "Releases an existing dedicated IPv4 subnet for a zone.", + "isasync": true, + "name": "releaseIpv4SubnetForZone", "params": [ { - "description": "ID of the project from where the role is to be deleted", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - }, - { - "description": "ID of the project role to be deleted", + "description": "Id of the guest network IPv4 subnet", "length": 255, "name": "id", - "related": "createProjectRole,listProjectRoles,updateProjectRole", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", "required": true, "type": "uuid" } ], + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the account of the IPv4 subnet", + "name": "account", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "guest IPv4 subnet", + "name": "subnet", + "type": "string" + }, + {}, + { + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "type": "string" + }, + { + "description": "id of the guest IPv4 subnet", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the IPv4 subnet", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", + "type": "string" + }, + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + { + "description": "the project name of the IPv4 subnet", + "name": "project", + "type": "string" } ], - "since": "4.15.0" + "since": "4.20.0" }, { - "description": "Changes ownership of a Volume from one account to another.", - "isasync": false, - "name": "assignVolume", + "description": "Updates an existing autoscale policy.", + "isasync": true, + "name": "updateAutoScalePolicy", "params": [ { - "description": "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", + "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", + "name": "quiettime", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "The ID of the volume to be reassigned.", + "description": "the ID of the autoscale policy", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "id", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, "type": "uuid" }, { - "description": "The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'.", + "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "conditionids", + "related": "listConditions", "required": false, - "type": "uuid" + "type": "list" + }, + { + "description": "the name of the autoscale policy", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", + "type": "string" + }, + { + "description": "the duration in which the conditions have to be true before action is taken", + "length": 255, + "name": "duration", + "required": false, + "type": "integer" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "listAutoScalePolicies", "response": [ { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the account owning the autoscale policy", + "name": "account", + "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the project name of the autoscale policy", + "name": "project", + "type": "string" }, + {}, { - "description": "pod name of the volume", - "name": "podname", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" + } + ] + }, + { + "description": "Creates a disk offering.", + "isasync": false, + "name": "createDiskOffering", + "params": [ + { + "description": "whether disk offering size is custom or not", + "length": 255, + "name": "customized", + "required": false, + "type": "boolean" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "length": 255, + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", + "required": false, + "since": "4.15", + "type": "uuid" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "length": 255, + "name": "disksizestrictness", + "required": false, + "since": "4.17", + "type": "boolean" }, { - "description": "ID of the availability zone", + "description": "the ID of the containing zone(s), null for public offerings", + "length": 255, "name": "zoneid", - "type": "string" + "related": "createZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "list" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "burst requests read rate of the disk offering", + "length": 255, + "name": "iopsreadratemax", + "required": false, "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "the ID of the containing domain(s), null for public offerings", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "list" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "bytes write rate of the disk offering", + "length": 255, + "name": "byteswriterate", + "required": false, + "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "length": 255, + "name": "provisioningtype", + "required": false, "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "min iops of the disk offering", + "length": 255, + "name": "miniops", + "required": false, + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "io requests write rate of the disk offering", + "length": 255, + "name": "iopswriterate", + "required": false, + "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "max iops of the disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "whether disk offering iops is custom or not", + "length": 255, + "name": "customizediops", + "required": false, + "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the storage type of the disk offering. Values are local and shared.", + "length": 255, + "name": "storagetype", + "required": false, "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "details to specify disk offering parameters", + "length": 255, + "name": "details", + "required": false, + "since": "4.16", + "type": "map" + }, + { + "description": "Volumes using this offering should be encrypted", + "length": 255, + "name": "encrypt", + "required": false, + "since": "4.18", + "type": "boolean" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopsreadratemaxlength", + "required": false, "type": "long" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "length (in seconds) of the burst", + "length": 255, + "name": "byteswriteratemaxlength", + "required": false, "type": "long" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopswriteratemaxlength", + "required": false, + "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadrate", + "required": false, + "type": "long" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "burst bytes write rate of the disk offering", + "length": 255, + "name": "byteswriteratemax", + "required": false, "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "an optional field, whether to display the offering to the end user or not.", + "length": 255, + "name": "displayoffering", + "required": false, "type": "boolean" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "io requests read rate of the disk offering", + "length": 255, + "name": "iopsreadrate", + "required": false, + "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "length": 255, + "name": "cachemode", + "required": false, + "since": "4.14", "type": "string" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "An alternate display text of the disk offering, defaults to 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "tags for the disk offering", + "length": 4096, + "name": "tags", + "required": false, "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "required": false, + "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "length": 255, + "name": "hypervisorsnapshotreserve", + "required": false, + "type": "integer" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "length": 255, + "name": "iopswriteratemax", + "required": false, + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", + "length": 255, + "name": "disksize", + "required": false, + "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "name of the disk offering", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "burst bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadratemax", + "required": false, + "type": "long" + } + ], + "related": "", + "response": [ + { + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "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": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" }, { - "description": "the state of the disk volume", + "description": "state of the disk offering", "name": "state", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "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 date the disk volume was created", - "name": "created", - "type": "date" + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", "type": "boolean" }, {}, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "pod id of the volume", - "name": "podid", - "type": "string" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" - } - ], - "since": "4.18.0.0" - }, - { - "description": "Deletes a userdata", - "isasync": false, - "name": "deleteUserData", - "params": [ - { - "description": "the ID of the Userdata", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "an optional project for the userdata", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" }, { - "description": "an optional account for the userdata. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", "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.18" - }, - { - "description": "Get SolidFire Account ID", - "isasync": false, - "name": "getSolidFireAccountId", - "params": [ - { - "description": "CloudStack Account UUID", - "length": 255, - "name": "accountid", - "required": true, - "type": "string" + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "Storage Pool UUID", - "length": 255, - "name": "storageid", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "SolidFire Account ID", - "name": "solidFireAccountId", - "type": "long" - }, - {} - ] - }, - { - "description": "Lists all network services provided by CloudStack or for the given Provider.", - "isasync": false, - "name": "listSupportedNetworkServices", - "params": [ - { - "description": "network service name to list providers and capabilities of", - "length": 255, - "name": "service", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "network service provider name", - "length": 255, - "name": "provider", - "required": false, + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "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" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "Lists role permissions", - "isasync": false, - "name": "listRolePermissions", - "params": [ - { - "description": "ID of the role", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the role permission", + "description": "unique ID of the disk offering", "name": "id", "type": "string" }, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "the description of the role permission", - "name": "description", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "Deletes a particular ingress rule from this security group", - "isasync": true, - "name": "revokeSecurityGroupIngress", - "params": [ - { - "description": "The ID of the ingress rule", - "length": 255, - "name": "id", - "related": "authorizeSecurityGroupIngress", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the disk offering", + "name": "name", "type": "string" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" } ] }, { - "description": "Lists dedicated guest vlan ranges", - "isasync": false, - "name": "listDedicatedGuestVlanRanges", + "description": "Creates a IPv4 subnet for a zone.", + "isasync": true, + "name": "createIpv4SubnetForZone", "params": [ { - "description": "list dedicated guest vlan ranges by id", - "length": 255, - "name": "id", - "related": "listDedicatedGuestVlanRanges", - "required": false, - "type": "uuid" - }, - { - "description": "the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", + "description": "domain ID of the account owning the IPv4 subnet", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "physical network id of the guest VLAN range", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "project who will own the guest VLAN range", + "description": "project who will own the IPv4 subnet", "length": 255, "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "related": "activateProject,createProject,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the dedicated guest vlan range", + "description": "The CIDR of the IPv4 subnet.", "length": 255, - "name": "guestvlanrange", - "required": false, + "name": "subnet", + "required": true, "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", + "description": "account who will own the IPv4 subnet", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "zone of the guest VLAN range", + "description": "UUID of the zone which the IPv4 subnet belongs to.", "length": 255, "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "related": "createZone,listZones,listZones", + "required": true, "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], - "related": "", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", "response": [ { - "description": "the project id of the guest vlan range", - "name": "projectid", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", - "type": "long" + "description": "id of the guest IPv4 subnet", + "name": "id", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the IPv4 subnet", + "name": "projectid", + "type": "string" }, { - "description": "the project name of the guest vlan range", + "description": "the project name of the IPv4 subnet", "name": "project", "type": "string" }, - {}, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, { @@ -50791,108 +50321,55 @@ var preCache = `{ "type": "string" }, { - "description": "the account of the guest VLAN range", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the zone of the guest vlan range", - "name": "zoneid", - "type": "long" + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", + "type": "string" }, {}, + {}, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", - "type": "string" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "Adds a network serviceProvider to a physical network", - "isasync": true, - "name": "addNetworkServiceProvider", + "description": "Lists details of network protocols", + "isasync": false, + "name": "listNetworkProtocols", "params": [ { - "description": "the name for the physical network service provider", + "description": "The option of network protocols. Supported values are: protocolnumber, icmptype.", "length": 255, - "name": "name", + "name": "option", "required": true, "type": "string" - }, - { - "description": "the destination Physical Network ID to bridge to", - "length": 255, - "name": "destinationphysicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - }, - { - "description": "the Physical Network ID to add the provider to", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "the list of services to be enabled for this physical network service provider", - "length": 255, - "name": "servicelist", - "required": false, - "type": "list" } ], - "related": "listNetworkServiceProviders,listTrafficTypes", + "related": "", "response": [ { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the provider name", + "description": "the name of the protocol parameter", "name": "name", "type": "string" }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -50902,81 +50379,40 @@ var preCache = `{ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists all network ACL items", - "isasync": false, - "name": "listNetworkACLs", - "params": [ - { - "description": "list network ACL items by ACL ID", - "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", - "required": false, - "type": "uuid" - }, - { - "description": "list network ACL items by traffic type - ingress or egress", - "length": 255, - "name": "traffictype", - "required": false, - "type": "string" - }, - { - "description": "Lists network ACL Item with the specified ID", - "length": 255, - "name": "id", - "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", - "required": false, - "type": "uuid" }, { - "description": "list network ACL items by action", - "length": 255, - "name": "action", - "required": false, - "type": "string" + "description": "the index (ID, Value, Code, Type, Option, etc) of the protocol parameter", + "name": "index", + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "the details of the protocol parameter", + "name": "details", + "type": "map" }, { - "description": "list network ACL items by protocol", - "length": 255, - "name": "protocol", - "required": false, + "description": "the description of the protocol parameter", + "name": "description", "type": "string" }, + {}, + {} + ], + "since": "4.19.0" + }, + { + "description": "Lists load balancer health check policies.", + "isasync": false, + "name": "listLBHealthCheckPolicies", + "params": [ { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isrecursive", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, { "description": "List by keyword", "length": 255, @@ -50984,933 +50420,1077 @@ var preCache = `{ "required": false, "type": "string" }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, - { - "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": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the health check policy", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "list network ACL items by network ID", + "description": "the ID of the load balancer rule", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "lbruleid", + "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", "required": false, "type": "uuid" } ], - "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", + "related": "createLBHealthCheckPolicy", "response": [ { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, - { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - {}, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the name of the ACL this item belongs to", - "name": "aclname", - "type": "string" - }, - { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ID of the ACL Item", - "name": "id", - "type": "string" - }, - { - "description": "the list of resource tags associated with the network ACLs", - "name": "tags", + "description": "the list of healthcheckpolicies", + "name": "healthcheckpolicy", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" }, { - "description": "tag value", - "name": "value", + "description": "the LB HealthCheck policy ID", + "name": "id", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the description of the healthcheck policy", + "name": "description", "type": "string" } ], "type": "list" }, + {}, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the domain of the HealthCheck policy", + "name": "domain", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" }, - {} - ] - }, - { - "description": "Delete site to site vpn gateway", - "isasync": true, - "name": "deleteVpnGateway", - "params": [ { - "description": "id of customer gateway", - "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways,updateVpnGateway", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "the account of the HealthCheck policy", + "name": "account", + "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", + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "Creates a service offering.", - "isasync": false, - "name": "createServiceOffering", + "description": "Attempts Migration of a VM with its volumes to a different host", + "isasync": true, + "name": "migrateVirtualMachineWithVolume", "params": [ { - "description": "details for planner, used to store specific parameters", + "description": "Automatically select a destination host for a running instance, if hostId is not specified. false by default", "length": 255, - "name": "serviceofferingdetails", + "name": "autoselect", "required": false, - "type": "map" + "since": "4.19.0", + "type": "boolean" }, { - "description": "io requests write rate of the disk offering", + "description": "Destination Host ID to migrate VM to.", "length": 255, - "name": "iopswriterate", + "name": "hostid", + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "the tags for this service offering.", + "description": "Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=&migrateto[volume-index].pool=Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume= indicates the UUID of the volume that you want to migrate, and pool= indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", "length": 255, - "name": "tags", + "name": "migrateto", "required": false, - "type": "string" + "type": "map" }, { - "description": "the host tag for this service offering.", + "description": "the ID of the virtual machine", "length": 255, - "name": "hosttags", - "required": false, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "response": [ + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "The minimum number of CPUs to be set with Custom Computer Offering", - "length": 255, - "name": "mincpunumber", - "required": false, - "since": "4.13", - "type": "integer" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "The maximum memory size of the custom service offering in MB", - "length": 255, - "name": "maxmemory", - "required": false, - "since": "4.13", - "type": "integer" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "max iops of the compute offering", - "length": 255, - "name": "maxiops", - "required": false, - "since": "4.4", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "restrict the CPU usage to committed service offering", - "length": 255, - "name": "limitcpuuse", - "required": false, - "type": "boolean" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "length": 255, - "name": "dynamicscalingenabled", - "required": false, - "since": "4.16", + "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": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the name of the service offering", - "length": 255, - "name": "name", - "required": true, + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the Root disk size in GB.", - "length": 255, - "name": "rootdisksize", - "required": false, - "since": "4.15", - "type": "long" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "io requests read rate of the disk offering", - "length": 255, - "name": "iopsreadrate", - "required": false, - "type": "long" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "Whether service offering size is custom or not", - "length": 255, - "name": "customized", - "required": false, - "since": "4.13", - "type": "boolean" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopsreadratemaxlength", - "required": false, + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the HA for the service offering", - "length": 255, - "name": "offerha", - "required": false, - "type": "boolean" - }, - { - "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": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadratemax", - "required": false, + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the total memory of the service offering in MB", - "length": 255, - "name": "memory", - "required": false, - "type": "integer" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "bytes write rate of the disk offering", - "length": 255, - "name": "byteswriterate", - "required": false, + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", - "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", - "required": false, - "since": "4.15", - "type": "uuid" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the storage type of the service offering. Values are local and shared.", - "length": 255, - "name": "storagetype", - "required": false, + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "is this a system vm offering", - "length": 255, - "name": "issystem", - "required": false, - "type": "boolean" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "length": 255, - "name": "diskofferingstrictness", - "required": false, - "since": "4.17", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "length": 255, - "name": "hypervisorsnapshotreserve", - "required": false, - "since": "4.4", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "byteswriteratemaxlength", - "required": false, - "type": "long" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", - "length": 255, - "name": "networkrate", - "required": false, - "type": "integer" - }, - { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "bytesreadratemaxlength", - "required": false, - "type": "long" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopswriteratemaxlength", - "required": false, - "type": "long" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "length": 255, - "name": "provisioningtype", - "required": false, + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "The display text of the service offering, defaults to 'name'.", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "VMs using this offering require root volume encryption", - "length": 255, - "name": "encryptroot", - "required": false, - "since": "4.18", - "type": "boolean" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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 key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "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": "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" + } + ], + "type": "set" + }, + { + "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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "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": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used", - "length": 255, - "name": "deploymentplanner", - "required": false, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the disk offering to which service offering should be mapped", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": false, - "since": "4.17", - "type": "uuid" - }, - { - "description": "burst requests read rate of the disk offering", - "length": 255, - "name": "iopsreadratemax", - "required": false, - "type": "long" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadrate", - "required": false, + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "The minimum memory size of the custom service offering in MB", - "length": 255, - "name": "minmemory", - "required": false, - "since": "4.13", - "type": "integer" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "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 ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the 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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + } + ], + "type": "set" }, { - "description": "whether compute offering iops is custom or not", - "length": 255, - "name": "customizediops", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "length": 255, - "name": "cachemode", - "required": false, - "since": "4.14", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", - "length": 255, - "name": "systemvmtype", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "length": 255, - "name": "byteswriteratemax", - "required": false, - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the CPU number of the service offering", - "length": 255, + "description": "the number of vCPUs this virtual machine is using", "name": "cpunumber", - "required": false, - "type": "integer" - }, - { - "description": "The maximum number of CPUs to be set with Custom Computer Offering", - "length": 255, - "name": "maxcpunumber", - "required": false, - "since": "4.13", "type": "integer" }, { - "description": "the CPU speed of the service offering in MHz.", - "length": 255, - "name": "cpuspeed", - "required": false, - "type": "integer" - }, - { - "description": "min iops of the compute offering", - "length": 255, - "name": "miniops", - "required": false, - "since": "4.4", - "type": "long" - }, - { - "description": "the ID of the containing domain(s), null for public offerings", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "list" - }, - { - "description": "true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM", - "length": 255, - "name": "isvolatile", - "required": false, - "type": "boolean" - }, - { - "description": "burst io requests write rate of the disk offering", - "length": 255, - "name": "iopswriteratemax", - "required": false, - "type": "long" - } - ], - "related": "updateServiceOffering,listServiceOfferings", - "response": [ - { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" - }, - { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" - }, - { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", - "type": "boolean" - }, - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" - }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", "type": "string" }, { - "description": "is this a system vm offering", - "name": "issystem", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" - }, - { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" - }, - { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "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 id of the service offering", - "name": "id", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the tags for the service offering", - "name": "storagetags", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the clock rate CPU speed in Mhz", + "description": "the speed of each vCPU", "name": "cpuspeed", "type": "integer" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, - {}, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, - {}, - { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" - }, - { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" - }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the name of the service offering", - "name": "name", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" - }, - { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" - }, - { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "description": "the ID of the availability zone for the virtual machine", "name": "zoneid", "type": "string" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" - }, - { - "description": "the memory in MB", - "name": "memory", - "type": "integer" - }, - { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" - } - ] - }, - { - "description": "Copies a template from one zone to another.", - "isasync": true, - "name": "copyTemplate", - "params": [ - { - "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", - "length": 255, - "name": "sourcezoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" }, { - "description": "Template ID.", - "length": 255, - "name": "id", - "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, - { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", - "length": 255, - "name": "destzoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" - } - ], - "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -51919,316 +51499,334 @@ var preCache = `{ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, {}, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, + {}, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", + "description": "the date when this virtual machine was created", + "name": "created", "type": "date" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the size of the template", - "name": "size", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "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", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", + "description": "Vm details in key/value pairs.", + "name": "details", "type": "map" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, + {}, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "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 domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" - }, + } + ] + }, + { + "description": "Lists GUI themes.", + "isasync": false, + "name": "listGuiThemes", + "params": [ { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the template name", + "description": "The name of the theme.", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "Whether to list removed themes.", + "length": 255, + "name": "showremoved", + "required": false, "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" - }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "Whether to list all themes.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "the ID of the domain to which the template belongs", + "description": "The ID of the domain to be filtered.", + "length": 255, "name": "domainid", - "type": "string" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "The internet Common Name (CN) to be filtered.", + "length": 255, + "name": "commonname", + "required": false, "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "Whether to list public themes.", + "length": 255, + "name": "showpublic", + "required": false, "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "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 contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "Whether to only list the default theme.", + "length": 255, + "name": "listonlydefaulttheme", + "required": false, "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" - } - ] - }, - { - "description": "lists network that are using a nicira nvp device", - "isasync": false, - "name": "listNiciraNvpDeviceNetworks", - "params": [ - { - "description": "nicira nvp device ID", + "description": "The ID of the account to be filtered.", "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", - "required": true, + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, "type": "uuid" }, { - "description": "", + "description": "The theme ID.", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listGuiThemes,createGuiTheme", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -52236,1984 +51834,1391 @@ var preCache = `{ "name": "page", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "related": "createGuiTheme", "response": [ { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "Name of the GUI theme.", + "name": "name", "type": "string" }, + {}, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "domainids", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "Whether to consider the subdomains of the informed domain IDs.", + "name": "recursivedomains", "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "When the GUI theme was removed.", + "name": "removed", + "type": "date" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "accountids", "type": "string" }, + {}, { - "description": "zone id of the network", - "name": "zoneid", + "description": "ID of the custom GUI theme.", + "name": "id", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the date this network was created", + "description": "When the GUI theme was created.", "name": "created", "type": "date" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "css", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" + "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", + "name": "ispublic", + "type": "boolean" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "Description of the GUI theme.", + "name": "description", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "jsonconfiguration", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "name": "commonnames", "type": "string" - }, - { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, + } + ], + "since": "4.21.0.0" + }, + { + "description": "Updates a user account", + "isasync": false, + "name": "updateUser", + "params": [ { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "User uuid", + "length": 255, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, + "type": "uuid" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "The secret key for the user. Must be specified with userApiKey", + "length": 255, + "name": "usersecretkey", + "required": false, "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" - }, - { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "Determines if Api key access for this user is enabled, disabled or inherits the value from its parent, the owning account", + "length": 255, + "name": "apikeyaccess", + "required": false, + "since": "4.20.1.0", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "first name", + "length": 255, + "name": "firstname", + "required": false, + "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "email", + "length": 255, + "name": "email", + "required": false, "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA", + "length": 255, + "name": "mandate2fa", + "required": false, + "since": "4.18.0.0", + "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "The API key for the user. Must be specified with userSecretKey", + "length": 255, + "name": "userapikey", + "required": false, "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "last name", + "length": 255, + "name": "lastname", + "required": false, "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "Unique username", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - }, + "description": "Current password that was being used by the user. You must inform the current password when updating the password.", + "length": 255, + "name": "currentpassword", + "required": false, + "type": "string" + } + ], + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "response": [ { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", + "description": "the account type of the user", + "name": "accounttype", "type": "integer" }, { - "description": "the id of the network", - "name": "id", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 external id of the network", - "name": "externalid", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, {}, { - "description": "state of the network", - "name": "state", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the domain id of the network owner", + "description": "the domain ID of the user", "name": "domainid", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, + {}, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "the name of the network", - "name": "name", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the account ID of the user", + "name": "accountid", "type": "string" - }, + } + ] + }, + { + "description": "Removes a certificate from a load balancer rule", + "isasync": true, + "name": "removeCertFromLoadBalancer", + "params": [ { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" - }, + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, {}, - { - "description": "the list of resource tags associated with network", - "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": "customer associated with the tag", - "name": "customer", - "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 domain associated with the tag", - "name": "domain", - "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": "list" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the type of the network", - "name": "type", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" } ] }, { - "description": "Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.", + "description": "Adds a new host.", "isasync": false, - "name": "assignVirtualMachine", + "name": "addHost", "params": [ { - "description": "id of the VM to be moved", + "description": "the cluster ID for the host", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, "type": "uuid" }, { - "description": "domain id of the new VM owner.", + "description": "hypervisor type of the host", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "list of tags to be added to the host", + "length": 255, + "name": "hosttags", "required": false, + "type": "list" + }, + { + "description": "the Pod ID for the host", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, "type": "uuid" }, { - "description": "account name of the new VM owner.", + "description": "the Zone ID for the host", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the host URL", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "length": 255, + "name": "username", "required": false, "type": "string" }, { - "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "networkids", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "password", "required": false, - "type": "list" + "type": "string" }, { - "description": "an optional project for the new VM owner.", + "description": "the cluster name for the host", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "clustername", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group.", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" + }, + { + "description": "Allocation state of this Host for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" + }, + { + "description": "comma separated list of storage access groups for the host", + "length": 255, + "name": "storageaccessgroups", "required": false, + "since": "4.21.0", "type": "list" } ], - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "response": [ { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", + "description": "the CPU number of the host", "name": "cpunumber", "type": "integer" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "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", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "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 account associated with the virtual machine", - "name": "account", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Vm details in key/value pairs.", + "description": "Host details in key/value pairs.", "name": "details", "type": "map" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + {}, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "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 after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" + }, + { + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" + }, + { + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "The ID of extension for this cluster", + "name": "extensionid", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" + }, + {}, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroup", "response": [ { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "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" - }, - { - "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project name of the group", - "name": "project", + "description": "GPU cards present in the host", + "name": "gpugroupname", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of enabled vGPUs", + "name": "vgpu", "response": [ { - "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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "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 name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "Model Name of vGPU", + "name": "vgputype", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" } ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" + "type": "list" } ], - "type": "set" + "type": "list" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - } - ], - "type": "set" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "CPU Arch of the host", + "name": "arch", "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 date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" + } + ] + }, + { + "description": "Attaches a disk volume to a virtual machine.", + "isasync": true, + "name": "attachVolume", + "params": [ + { + "description": "the ID of the disk volume", + "length": 255, "name": "id", - "type": "string" + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": " the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.
When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:
  • 0 maps to /dev/xvda;
  • 1 maps to /dev/xvdb;
  • 2 maps /dev/xvdc and so on.
Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure.", + "length": 255, + "name": "deviceid", + "required": false, + "type": "long" + } + ], + "related": "createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "response": [ + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, - {}, - {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "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" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "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 project ID of the affinity group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "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 userdata used for the VM", - "name": "userdataname", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, + {}, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "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 chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists virtual machines on a unmanaged host", - "isasync": false, - "name": "listVmsForImport", - "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the host name or IP address", - "length": 255, - "name": "host", - "required": true, - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "hypervisor type of the host", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the password for the host", - "length": 255, - "name": "password", - "required": false, + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "the username for the host", - "length": 255, - "name": "username", - "required": false, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" - } - ], - "related": "listVmwareDcVms,listUnmanagedInstances", - "response": [ + }, { - "description": "the list of nics associated with the virtual machine", - "name": "nic", - "response": [ - { - "description": "the name of the corresponding network", - "name": "networkname", - "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 IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - } - ], - "type": "set" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", "type": "string" }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, { "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": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, - {}, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorepath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the disk", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorehost", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorename", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the label of the disk", - "name": "label", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the controller of the disk", - "name": "controller", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "the position of the disk", - "name": "position", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "set" }, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the memory of the virtual machine in MB", - "name": "memory", + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" } - ], - "since": "4.19.0" + ] }, { - "description": " delete a BigSwitch BCF Controller device", - "isasync": true, - "name": "deleteBigSwitchBcfDevice", + "description": "Deletes a CNI Configuration", + "isasync": false, + "name": "deleteCniConfiguration", "params": [ { - "description": "BigSwitch device ID", + "description": "the ID of the Userdata", "length": 255, - "name": "bcfdeviceid", - "related": "listBigSwitchBcfDevices", + "name": "id", + "related": "listCniConfiguration", "required": true, "type": "uuid" + }, + { + "description": "an optional project for the userdata", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the userdata. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "response": [ @@ -54223,9 +53228,9 @@ var preCache = `{ "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" }, {}, { @@ -54233,1329 +53238,1403 @@ var preCache = `{ "name": "jobid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], - "since": "4.6.0" + "since": "4.21.0" }, { - "description": "configures a netscaler load balancer device", + "description": "Updates a project", "isasync": true, - "name": "configureNetscalerLoadBalancer", + "name": "updateProject", "params": [ { - "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", + "description": "id of the project to be modified", "length": 255, - "name": "lbdevicededicated", - "required": false, - "type": "boolean" + "name": "id", + "related": "activateProject,createProject,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { - "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", + "description": "name of the project", "length": 255, - "name": "lbdevicecapacity", + "name": "name", "required": false, - "type": "long" + "since": "4.19.0", + "type": "string" }, { - "description": "Netscaler load balancer device ID", + "description": "ID of the user to be promoted/demoted", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", - "required": true, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": false, "type": "uuid" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "description": "display text of the project", "length": 255, - "name": "podids", - "related": "updatePod,createManagementNetworkIpRange", + "name": "displaytext", "required": false, - "type": "list" + "type": "string" }, { - "description": "true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall", + "description": "new Admin account for the project", "length": 255, - "name": "inline", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Account level role to be assigned to the user/account : Admin/Regular", + "length": 255, + "name": "roletype", + "required": false, + "type": "string" + }, + { + "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", + "length": 255, + "name": "swapowner", "required": false, "type": "boolean" } ], - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "related": "activateProject,createProject,suspendProject", "response": [ { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, + {}, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, - {}, { - "description": "name of the provider", - "name": "provider", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "the id of the project", + "name": "id", + "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project 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" + } + ], + "type": "list" + }, + { + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "device state", - "name": "lbdevicestate", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "device name", - "name": "lbdevicename", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" - } - ] - }, - { - "description": "Lists all available ovs elements.", - "isasync": false, - "name": "listOvsElements", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "list network offerings by enabled state", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "list ovs elements by id", - "length": 255, - "name": "id", - "related": "listOvsElements,configureOvsElement", - "required": false, - "type": "uuid" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "list ovs elements by network service provider id", - "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders,listTrafficTypes", - "required": false, - "type": "uuid" - } - ], - "related": "configureOvsElement", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the id of the ovs", - "name": "id", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the project name of the address", - "name": "project", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, - {}, - {}, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", + "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" - } - ] - }, - { - "description": "delete Tungsten-Fabric service group", - "isasync": true, - "name": "deleteTungstenFabricServiceGroup", - "params": [ + }, { - "description": "the uuid of Tungsten-Fabric service group", - "length": 255, - "name": "servicegroupuuid", - "required": true, + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the state of the project", + "name": "state", + "type": "string" + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "associate a profile to a blade", - "isasync": true, - "name": "associateUcsProfileToBlade", - "params": [ { - "description": "ucs manager id", - "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", - "required": true, - "type": "uuid" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "blade id", - "length": 255, - "name": "bladeid", - "related": "associateUcsProfileToBlade", - "required": true, - "type": "uuid" + "description": "the total number of gpus the project can own", + "name": "gpulimit", + "type": "string" }, { - "description": "profile dn", - "length": 255, - "name": "profiledn", - "required": true, + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "ucs blade id", - "name": "id", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { - "description": "ucs manager id", - "name": "ucsmanagerid", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "ucs blade dn", - "name": "bladedn", - "type": "string" + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" }, { - "description": "associated ucs profile dn", - "name": "profiledn", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, + {}, { - "description": "cloudstack host id this blade associates to", - "name": "hostid", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, - {}, - {} - ] - }, - { - "description": "Adds a object storage pool", - "isasync": false, - "name": "addObjectStoragePool", - "params": [ { - "description": "the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the URL for the object store", - "length": 2048, - "name": "url", - "required": true, + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the name for the object store", - "length": 255, - "name": "name", - "required": true, + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the tags for the storage pool", - "length": 255, - "name": "tags", - "required": false, + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "the object store provider name", - "length": 255, - "name": "provider", - "required": true, + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the provider name of the object store", - "name": "providername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the project", + "name": "name", + "type": "string" }, { - "description": "the object store currently used size", - "name": "storageused", - "type": "long" + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the name of the object store", - "name": "name", + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "the url of the object store", - "name": "url", + "description": "the total number of backups available to this project", + "name": "backupavailable", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the ID of the object store", - "name": "id", - "type": "string" + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" }, { - "description": "the total size of the object store", - "name": "storagetotal", + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", "type": "long" }, - {}, - {} + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + } ], - "since": "4.19.0" + "since": "3.0.0" }, { - "description": "Updates a VMware datacenter details for a zone", + "description": "Lists internal load balancers", "isasync": false, - "name": "updateVmwareDc", + "name": "listLoadBalancers", "params": [ { - "description": "The username required to connect to resource.", + "description": "", "length": 255, - "name": "username", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the name of the load balancer", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "The zone ID", + "description": "the ID of the load balancer", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "id", + "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "required": false, "type": "uuid" }, { - "description": "The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "vcenter", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The password for specified username.", + "description": "the scheme of the load balancer. Supported value is internal in the current release", "length": 255, - "name": "password", + "name": "scheme", "required": false, "type": "string" }, { - "description": "VMware datacenter name.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" - } - ], - "related": "addVmwareDc,listVmwareDcs", - "response": [ + }, { - "description": "The VMware Datacenter ID", - "name": "id", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "The VMware Datacenter name", - "name": "name", - "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" }, { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "description": "the source IP address of the load balancer", + "length": 255, + "name": "sourceipaddress", + "required": false, "type": "string" }, - {}, - { - "description": "the Zone ID associated with this VMware Datacenter", - "name": "zoneid", - "type": "long" - } - ], - "since": "4.12.0" - }, - { - "description": "Deletes user from the project", - "isasync": true, - "name": "deleteUserFromProject", - "params": [ { - "description": "ID of the project to remove the user from", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, + "related": "activateProject,createProject,suspendProject", + "required": false, "type": "uuid" }, { - "description": "Id of the user to be removed from the project", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the network ID of the load balancer", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "the network ID of the source IP address", + "length": 255, + "name": "sourceipaddressnetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, "type": "uuid" } ], + "related": "createLoadBalancer", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the list of resource tags associated with the Load Balancer", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the description of the Load Balancer", + "name": "description", + "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the domain ID of the Load Balancer", + "name": "domainid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + }, + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the account of the Load Balancer", + "name": "account", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", "type": "boolean" }, - {} - ], - "since": "4.15.0" - }, - { - "description": "Checks the 2FA code for the user.", - "isasync": false, - "name": "validateUserTwoFactorAuthenticationCode", - "params": [ { - "description": "two factor authentication code", - "length": 255, - "name": "codefor2fa", - "required": true, + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" - } - ], - "response": [ + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.18.0" - }, - { - "description": "Starts a router.", - "isasync": false, - "name": "getRouterHealthCheckResults", - "params": [ + "description": "the name of the Load Balancer", + "name": "name", + "type": "string" + }, { - "description": "the ID of the router", - "length": 255, - "name": "routerid", - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", - "required": true, - "type": "uuid" + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" }, { - "description": "if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched", - "length": 255, - "name": "performfreshchecks", - "required": false, - "type": "boolean" - } - ], - "related": "", - "response": [ + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, { - "description": "the id of the router", - "name": "routerid", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" }, - {}, { - "description": "the id of the router", - "name": "healthchecks", + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "the ip address of the instance", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the instance", + "name": "name", + "type": "string" + }, + { + "description": "the state of the instance", + "name": "state", + "type": "string" + }, + { + "description": "the instance ID", + "name": "id", + "type": "string" + } + ], "type": "list" }, + {}, + { + "description": "the project id of the Load Balancer", + "name": "projectid", + "type": "string" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } ], - "since": "4.14.0" + "since": "4.2.0" }, { - "description": "list control center", + "description": "This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user", "isasync": false, - "name": "listNetscalerControlCenter", + "name": "registerUserKeys", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "User id", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "getUserKeys", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the api key of the registered user", + "name": "apikey", "type": "string" }, + {}, { - "description": "num_retries", - "name": "numretries", + "description": "the secret key of the registered user", + "name": "secretkey", "type": "string" }, - {}, { - "description": "username", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "uuid", - "name": "uuid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ncc_ip", - "name": "ipaddress", - "type": "string" + "description": "whether api key access is allowed or not", + "name": "apikeyaccess", + "type": "boolean" }, + {} + ] + }, + { + "description": "Deletes a load balancer stickiness policy.", + "isasync": true, + "name": "deleteLBStickinessPolicy", + "params": [ { - "description": "id", + "description": "the ID of the LB stickiness policy", + "length": 255, "name": "id", + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", + "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": "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" } - ] + ], + "since": "3.0.0" }, { - "description": "Resizes a volume", - "isasync": true, - "name": "resizeVolume", + "description": "Lists site to site vpn connection gateways", + "isasync": false, + "name": "listVpnConnections", "params": [ { - "description": "Verify OK to Shrink", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "shrinkok", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "New minimum number of IOPS", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "miniops", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "the ID of the disk volume", + "description": "id of the vpn connection", "length": 255, "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "required": false, "type": "uuid" }, { - "description": "New volume size in GB", + "description": "List by keyword", "length": 255, - "name": "size", + "name": "keyword", "required": false, - "type": "long" + "type": "string" }, { - "description": "New maximum number of IOPS", + "description": "", "length": 255, - "name": "maxiops", + "name": "page", "required": false, - "type": "long" + "type": "integer" }, { - "description": "new disk offering id", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, "type": "uuid" - } - ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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": "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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "id of vpc", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "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": "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": "provisioning type used to create volumes.", - "name": "provisioningtype", - "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": "createVpnConnection,updateVpnConnection", + "response": [ { - "description": "the disk utilization", - "name": "utilization", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "the status of the volume", - "name": "status", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, {}, + {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "description": "ID of the disk volume", + "description": "the connection ID", "name": "id", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the owner", + "name": "account", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + } + ] + }, + { + "description": "remove Tungsten-Fabric policy", + "isasync": true, + "name": "removeTungstenFabricPolicy", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the uuid of Tungsten-Fabric network", + "length": 255, + "name": "networkuuid", + "required": true, "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" + } + ], + "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy", + "response": [ + {}, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Migrate current NFS secondary storages to use object store.", + "isasync": false, + "name": "updateCloudToUseObjectStore", + "params": [ { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the URL for the image store", + "length": 255, + "name": "url", + "required": false, "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the name for the image store", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, + "description": "the image store provider name", + "length": 255, + "name": "provider", + "required": true, + "type": "string" + } + ], + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", + "response": [ { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "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": "type of the virtual machine", - "name": "vmtype", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "pod name of the volume", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the ID of the image store", + "name": "id", "type": "string" - } - ] + }, + {} + ], + "since": "4.3.0" }, { - "description": "Deletes affinity group", - "isasync": true, - "name": "deleteAffinityGroup", + "description": "Creates a range of Autonomous Systems for BGP Dynamic Routing", + "isasync": false, + "name": "createASNRange", "params": [ { - "description": "the account of the affinity group. Must be specified with domain ID", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "The name of the affinity group. Mutually exclusive with ID parameter", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "The ID of the affinity group. Mutually exclusive with name parameter", + "description": "the start AS Number", "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" + "name": "startasn", + "required": true, + "type": "long" }, { - "description": "the domain ID of account owning the affinity group", + "description": "the end AS Number", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "name": "endasn", + "required": true, + "type": "long" }, { - "description": "the project of the affinity group", + "description": "the zone ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, "type": "uuid" } ], + "related": "listASNRanges", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "Created date", + "name": "created", + "type": "date" + }, + { + "description": "End AS Number", + "name": "endasn", + "type": "long" }, + {}, { "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": "Zone ID", + "name": "zoneid", + "type": "string" }, + { + "description": "ID of the AS Number Range", + "name": "id", + "type": "string" + }, + { + "description": "Start AS Number", + "name": "startasn", + "type": "long" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - {} - ] + } + ], + "since": "4.20.0" }, { - "description": "Deletes a network offering.", - "isasync": false, - "name": "deleteNetworkOffering", + "description": "add Tungsten-Fabric network gateway to logical router", + "isasync": true, + "name": "addTungstenFabricNetworkGatewayToLogicalRouter", "params": [ { - "description": "the ID of the network offering", + "description": "Tungsten-Fabric network uuid", "length": 255, - "name": "id", - "related": "listNetworkOfferings", + "name": "networkuuid", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "Tungsten-Fabric logical router uuid", + "length": 255, + "name": "logicalrouteruuid", + "required": true, + "type": "string" } ], + "related": "createTungstenFabricLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter,listTungstenFabricLogicalRouter", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Tungsten-Fabric logical router name", + "name": "name", + "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Deletes a Network Service Provider.", - "isasync": true, - "name": "deleteNetworkServiceProvider", - "params": [ - { - "description": "the ID of the network service provider", - "length": 255, - "name": "id", - "related": "listNetworkServiceProviders,listTrafficTypes", - "required": true, - "type": "uuid" - } - ], - "response": [ + }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -55564,37 +54643,32 @@ var preCache = `{ "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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" - } - ], - "since": "3.0.0" + {} + ] }, { - "description": "List network devices", + "description": "list Tungsten-Fabric nic", "isasync": false, - "name": "listNetworkDevice", + "name": "listTungstenFabricNic", "params": [ { - "description": "parameters for network device", + "description": "", "length": 255, - "name": "networkdeviceparameterlist", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", + "description": "the ID of zone", "length": 255, - "name": "networkdevicetype", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -55604,292 +54678,191 @@ var preCache = `{ "type": "integer" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric nic", "length": 255, - "name": "keyword", + "name": "nicuuid", "required": false, "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], - "related": "addNetworkDevice", + "related": "", "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { - "description": "the ID of the network device", - "name": "id", + "description": "Tungsten-Fabric nic uuid", + "name": "uuid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Update a Storage network IP range, only allowed when no IPs in this range have been allocated.", - "isasync": true, - "name": "updateStorageNetworkIpRange", - "params": [ - { - "description": "the netmask for storage network", - "length": 255, - "name": "netmask", - "required": false, - "type": "string" - }, - { - "description": "the ending IP address", - "length": 255, - "name": "endip", - "required": false, - "type": "string" - }, - { - "description": "UUID of storage network ip range", - "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "the beginning IP address", - "length": 255, - "name": "startip", - "required": false, - "type": "string" - }, - { - "description": "Optional. the vlan the ip range sits on", - "length": 255, - "name": "vlan", - "required": false, - "type": "integer" - } - ], - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", - "response": [ - { - "description": "the netmask of the storage network IP range", - "name": "netmask", - "type": "string" - }, - {}, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" }, { - "description": "the Zone uuid of the storage network IP range", + "description": "Tungsten-Fabric provider zone id", "name": "zoneid", - "type": "string" + "type": "long" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, {}, + {}, { - "description": "the gateway of the storage network IP range", - "name": "gateway", - "type": "string" - }, - { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "Tungsten-Fabric nic 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": "the uuid of storage network IP range.", - "name": "id", - "type": "string" - }, - { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", - "type": "string" - }, - { - "description": "the network uuid of storage network IP range", - "name": "networkid", - "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Dedicates a Pod.", - "isasync": true, - "name": "dedicatePod", + "description": "Retrieves VMware DC(s) associated with a zone.", + "isasync": false, + "name": "listVmwareDcs", "params": [ { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "description": "Id of the CloudStack zone.", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the containing domain", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the ID of the Pod", + "description": "", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" } ], - "related": "listDedicatedPods", + "related": "addVmwareDc", "response": [ + {}, { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", - "type": "string" - }, - { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the ID of the Pod", - "name": "podid", + "description": "The VMware vCenter name/ip", + "name": "vcenter", "type": "string" }, - {}, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", + "description": "The VMware Datacenter ID", + "name": "id", "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": "the Name of the Pod", - "name": "podname", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" } ] }, { - "description": "Lists Project roles in CloudStack", - "isasync": false, - "name": "listProjectRoles", + "description": "apply Tungsten-Fabric policy", + "isasync": true, + "name": "applyTungstenFabricPolicy", "params": [ { - "description": "", + "description": "the major sequence of Tungsten-Fabric policy", "length": 255, - "name": "page", - "required": false, + "name": "majorsequence", + "required": true, "type": "integer" }, { - "description": "List project role by project ID.", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "policyuuid", "required": true, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "type": "string" }, { - "description": "List project role by project role name.", + "description": "the uuid of network", "length": 255, - "name": "name", - "required": false, + "name": "networkuuid", + "required": true, "type": "string" }, { - "description": "List project role by project role ID.", + "description": "the ID of zone", "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": false, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, "type": "uuid" }, { - "description": "List by keyword", + "description": "the minor sequence of Tungsten-Fabric policy", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "minorsequence", + "required": true, + "type": "integer" } ], - "related": "createProjectRole,updateProjectRole", + "related": "createTungstenFabricPolicy,listTungstenFabricPolicy", "response": [ { - "description": "the description of the role", - "name": "description", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, { - "description": "the id of the project", - "name": "projectid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, {}, { - "description": "the ID of the role", - "name": "id", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, {}, { @@ -55897,664 +54870,523 @@ var preCache = `{ "name": "jobstatus", "type": "integer" }, - { - "description": "the name of the role", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.15.0" - }, - { - "description": "Removes an OpenDyalight controler", - "isasync": true, - "name": "deleteOpenDaylightController", - "params": [ - { - "description": "OpenDaylight Controller ID", - "length": 255, - "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController", - "required": true, - "type": "uuid" - } - ], - "related": "addOpenDaylightController", - "response": [ {}, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the name assigned to the controller", - "name": "name", - "type": "string" - }, - { - "description": "the url of the controller api", - "name": "url", - "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": "the username to authenticate to the controller", - "name": "username", - "type": "string" - }, - { - "description": "device id of the controller", - "name": "id", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, { - "description": "Updates attributes of a template.", + "description": "Lists zones", "isasync": false, - "name": "updateTemplate", + "name": "listZones", "params": [ { - "description": "true if the image supports the password reset feature; default is false", + "description": "the name of the zone", "length": 255, - "name": "passwordenabled", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "the name of the storage access group", "length": 255, - "name": "bootable", + "name": "storageaccessgroup", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "string" }, { - "description": "the name of the image file", + "description": "flag to display the capacity of the zones", "length": 255, - "name": "name", + "name": "showcapacities", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the image file", + "description": "flag to display the resource image for the zones", "length": 255, - "name": "id", - "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "name": "showicon", + "required": false, + "type": "boolean" }, { - "description": "sort key of the template, integer", + "description": "", "length": 255, - "name": "sortkey", + "name": "page", "required": false, "type": "integer" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "the network type of the zone that the virtual machine belongs to", "length": 255, - "name": "details", + "name": "networktype", "required": false, - "type": "map" + "type": "string" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "List zones by resource tags (key/value pairs)", "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" - }, - { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "name": "tags", "required": false, - "type": "string" + "since": "4.3", + "type": "map" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "", "length": 255, - "name": "sshkeyenabled", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the format for the image", + "description": "the IDs of the zones, mutually exclusive with id", "length": 255, - "name": "format", + "name": "ids", + "related": "createZone,listZones,listZones", "required": false, - "type": "string" + "since": "4.19.0", + "type": "list" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", "length": 255, - "name": "isrouting", + "name": "available", "required": false, "type": "boolean" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "List by keyword", "length": 255, - "name": "templatetype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "the ID of the zone", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", + "name": "id", + "related": "createZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" - }, - { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "cleanupdetails", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" } ], - "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "createZone,listZones", "response": [ { - "description": "the template name", - "name": "name", - "type": "string" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" - }, - { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the type of the zone - core or edge", + "name": "type", + "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" }, { - "description": "the template ID", + "description": "Zone id", "name": "id", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, - {}, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true, if routed network/vpc is enabled", + "name": "routedmodeenabled", "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "description": "the list of resource tags associated with zone.", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", "type": "boolean" }, - {}, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "External network provider if any", + "name": "provider", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Zone ID", + "name": "zoneid", "type": "string" } ], - "type": "set" - }, - { - "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": "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" + "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } - ] - }, - { - "description": "Creates a VLAN IP range.", - "isasync": false, - "name": "createVlanIpRange", - "params": [ - { - "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", - "length": 255, - "name": "account", - "required": false, + "description": "Zone description", + "name": "description", "type": "string" }, + {}, { - "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the Zone ID of the VLAN IP range", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "Used GPUs in the Zone", + "name": "gpuused", + "type": "long" }, + {}, { - "description": "the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged", - "length": 255, - "name": "vlan", - "required": false, + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the physical network id", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { - "description": "domain ID of the account owning a VLAN", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "length": 255, - "name": "gateway", - "required": false, + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", - "length": 255, - "name": "endipv6", - "required": false, + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "the ending IP address in the VLAN IP range", - "length": 255, - "name": "endip", - "required": false, + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", - "length": 255, - "name": "startipv6", - "required": false, - "type": "string" + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", - "length": 255, - "name": "ip6gateway", - "required": false, + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { - "description": "the netmask of the VLAN IP range", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Create an extension", + "isasync": false, + "name": "createExtension", + "params": [ + { + "description": "Name of the extension", "length": 255, - "name": "netmask", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the network id", + "description": "Type of the extension", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "name": "type", + "required": true, + "type": "string" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "Relative path for the extension", "length": 255, - "name": "startip", + "name": "path", "required": false, "type": "string" }, { - "description": "true if VLAN is of Virtual type, false if Direct", + "description": "State of the extension", "length": 255, - "name": "forvirtualnetwork", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if IP range is set to system vms, false if not", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", "length": 255, - "name": "forsystemvms", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "description": "Description of the extension", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "Only honored when type is Orchestrator. Whether prepare VM is needed or not", "length": 255, - "name": "ip6cidr", + "name": "orchestratorrequirespreparevm", "required": false, - "type": "string" + "type": "boolean" } ], - "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", "response": [ { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "ID of the extension", + "name": "id", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", - "type": "string" + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The details of the extension", + "name": "details", + "type": "map" }, { "description": "the UUID of the latest async job acting on this object", @@ -56562,85 +55394,146 @@ var preCache = `{ "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "The path of the entry point fo the extension", + "name": "path", "type": "string" }, + {}, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "The state of the extension", + "name": "state", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", "type": "boolean" }, + {}, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "Type of the extension", + "name": "type", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", - "type": "string" + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "Name of the extension", + "name": "name", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "Description of the extension", + "name": "description", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "List of resources to which extension is registered to", + "name": "resources", + "response": [ + { + "description": "the details of the resource map", + "name": "details", + "type": "map" + }, + { + "description": "Type of the resource", + "name": "type", + "type": "string" + }, + { + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" + }, + { + "description": "ID of the resource associated with the extension", + "name": "id", + "type": "string" + }, + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + {} + ], + "since": "4.21.0" + }, + { + "description": "Removes a public IP address from quarantine. Only IPs in active quarantine can be removed.", + "isasync": false, + "name": "removeQuarantinedIp", + "params": [ + { + "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "The ID of the public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "length": 255, + "name": "id", + "related": "listQuarantinedIps,updateQuarantinedIp,removeQuarantinedIp", + "required": false, + "type": "uuid" }, - {}, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The reason for removing the public IP address from quarantine prematurely.", + "length": 255, + "name": "removalreason", + "required": true, + "type": "string" + } + ], + "related": "listQuarantinedIps,updateQuarantinedIp", + "response": [ + { + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "ID of the quarantine process.", + "name": "id", "type": "string" }, { @@ -56649,108 +55542,119 @@ var preCache = `{ "type": "integer" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the end ip of the VLAN IP range", - "name": "endip", - "type": "string" + "description": "When the quarantine was created.", + "name": "created", + "type": "date" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", - "type": "string" - }, - { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", - "type": "string" - }, - { - "description": "the network id of vlan range", - "name": "networkid", - "type": "string" - }, - { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", - "type": "string" + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" } - ] + ], + "since": "4.19" }, { - "description": "Updates site to site vpn connection", - "isasync": true, - "name": "updateVpnConnection", + "description": "Deletes the backup schedule of a VM", + "isasync": false, + "name": "deleteBackupSchedule", "params": [ { - "description": "id of vpn connection", + "description": "ID of the backup schedule to be deleted. It has precedence over the 'virtualmachineid' parameter, i.e., when the 'id' parameter is specified, the 'virtualmachineid' parameter will be ignored.", "length": 255, "name": "id", - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", - "required": true, - "type": "uuid" - }, - { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", + "related": "listBackupSchedule", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.20.1", + "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "ID of the VM from which all backup schedules will be deleted.", "length": 255, - "name": "customid", + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" } ], - "related": "createVpnConnection,listVpnConnections", "response": [ { - "description": "the public IP address", - "name": "publicip", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", - "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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, + } + ], + "since": "4.14.0" + }, + { + "description": "Lists external backup offerings of the provider", + "isasync": false, + "name": "listBackupProviderOfferings", + "params": [ { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the project name", - "name": "project", - "type": "string" + "description": "The zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "importBackupOffering,listBackupOfferings,updateBackupOffering", + "response": [ + { + "description": "provider name", + "name": "provider", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "zone ID", + "name": "zoneid", "type": "string" }, { @@ -56759,103 +55663,93 @@ var preCache = `{ "type": "integer" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, - { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "ID of the backup offering", + "name": "id", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "description for the backup offering", + "name": "description", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the date this backup offering was created", + "name": "created", + "type": "date" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "external ID on the provider side", + "name": "externalid", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the connection ID", - "name": "id", + "description": "name for the backup offering", + "name": "name", "type": "string" }, {}, + {}, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "whether offering allows user driven ad-hoc/scheduled backups", + "name": "allowuserdrivenbackups", + "type": "boolean" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "zone name", + "name": "zonename", "type": "string" - }, + } + ], + "since": "4.14.0" + }, + { + "description": "Releases a Public IP range back to the system pool", + "isasync": false, + "name": "releasePublicIpRange", + "params": [ { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" - }, + "description": "the id of the Public IP range", + "length": 255, + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "State of vpn connection", - "name": "state", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } - ], - "since": "4.4" + ] }, { - "description": "lists network that are using Palo Alto firewall device", + "description": "lists network that are using a netscaler load balancer device", "isasync": false, - "name": "listPaloAltoFirewallNetworks", + "name": "listNetscalerLoadBalancerNetworks", "params": [ { "description": "", @@ -56865,38 +55759,44 @@ var preCache = `{ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "palo alto balancer device ID", + "description": "netscaler load balancer device ID", "length": 255, "name": "lbdeviceid", - "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", "required": true, "type": "uuid" } ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { @@ -56905,13 +55805,28 @@ var preCache = `{ "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the owner of the network", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { @@ -56920,24 +55835,49 @@ var preCache = `{ "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "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 domain id of the network owner", - "name": "domainid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { "description": "the first IPv6 DNS for the network", @@ -56945,54 +55885,64 @@ var preCache = `{ "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the type of the network", - "name": "type", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "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", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { "description": "true if the entity/resource has annotations", @@ -57000,38 +55950,142 @@ var preCache = `{ "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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" + } + ], + "type": "list" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" }, { "description": "the list of services", "name": "service", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", "type": "boolean" }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ { "description": "the destination physical network", "name": "destinationphysicalnetworkid", @@ -57042,11 +56096,6 @@ var preCache = `{ "name": "id", "type": "string" }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { "description": "state of the network provider", "name": "state", @@ -57058,56 +56107,34 @@ var preCache = `{ "type": "list" }, { - "description": "the provider name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "the provider name", + "name": "name", "type": "string" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { @@ -57116,69 +56143,59 @@ var preCache = `{ "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - {}, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, + {}, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { @@ -57186,136 +56203,59 @@ var preCache = `{ "name": "domainpath", "type": "string" }, - { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" - }, { "description": "if network offering supports vm autoscaling feature", "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "the name of the network", - "name": "name", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "state of the network", - "name": "state", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { @@ -57324,33 +56264,23 @@ var preCache = `{ "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, - { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" - }, - { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "the project name of the address", - "name": "project", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { @@ -57358,104 +56288,59 @@ var preCache = `{ "name": "strechedl2subnet", "type": "boolean" }, - {}, { - "description": "the network's netmask", - "name": "netmask", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" } ] }, { - "description": "Synchronize Tungsten-Fabric data", + "description": "create Tungsten-Fabric public network", "isasync": false, - "name": "synchronizeTungstenFabricData", + "name": "createTungstenFabricPublicNetwork", "params": [ { - "description": "provider id", + "description": "the ID of zone", "length": 255, - "name": "id", - "related": "listTungstenFabricProviders", + "name": "zoneid", + "related": "createZone,listZones", "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" - } - ] - }, - { - "description": "Get the path associated with the provided volume UUID", - "isasync": false, - "name": "getPathForVolume", - "params": [ - { - "description": "CloudStack Volume UUID", - "length": 255, - "name": "volumeid", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "The path field for the volume", - "name": "path", - "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": "the UUID of the latest async job acting on this object", @@ -57465,22 +56350,21 @@ var preCache = `{ ] }, { - "description": "Lists management servers.", + "description": "Lists supported methods of network isolation", "isasync": false, - "name": "listManagementServers", + "name": "listNetworkIsolationMethods", "params": [ { - "description": "the id of the management server", + "description": "", "length": 255, - "name": "id", - "related": "listManagementServers", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the name of the management server", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, @@ -57490,183 +56374,151 @@ var preCache = `{ "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" } ], "related": "", "response": [ { - "description": "the last time this Management Server was started", - "name": "lastserverstart", - "type": "date" + "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 java distribution name running the management server process", - "name": "javadistribution", - "type": "string" - }, {}, {}, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", - "type": "string" - }, - { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", - "type": "string" - }, - { - "description": "the name of the management server", + "description": "Network isolation method name", "name": "name", "type": "string" - }, + } + ], + "since": "4.2.0" + }, + { + "description": "Lists host HA resources", + "isasync": false, + "name": "listHostHAResources", + "params": [ { - "description": "the state of the management server", - "name": "state", - "type": "state" - }, + "description": "List by host ID", + "length": 255, + "name": "hostid", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + } + ], + "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", + "response": [ { - "description": "the version of the management server", - "name": "version", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" + "description": "operation status", + "name": "status", + "type": "boolean" }, { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the IP Address for this Management Server", - "name": "serviceip", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, + {}, { - "description": "the ID of the management server", - "name": "id", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" } - ] + ], + "since": "4.11" }, { - "description": "list Tungsten-Fabric policy", + "description": "list Tungsten-Fabric firewall policy", "isasync": false, - "name": "listTungstenFabricPolicyRule", + "name": "listTungstenFabricFirewallPolicy", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "firewallpolicyuuid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric rule", + "description": "", "length": 255, - "name": "ruleuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of zone", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "policyuuid", - "required": true, + "name": "applicationpolicysetuuid", + "required": false, "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], - "related": "addTungstenFabricPolicyRule", + "related": "createTungstenFabricFirewallPolicy", "response": [ - { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", - "type": "int" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "Tungsten-Fabric policy action", - "name": "action", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, - {}, { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric firewall policy name", + "name": "name", "type": "string" }, { @@ -57675,295 +56527,252 @@ var preCache = `{ "type": "string" }, { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", - "type": "string" - }, - { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy name", - "name": "direction", - "type": "string" - }, - { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", - "type": "string" - }, - {}, - { - "description": "Tungsten-Fabric rule uuid", + "description": "Tungsten-Fabric firewall policy uuid", "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix", - "name": "srcipprefix", - "type": "string" + "description": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - } + {} ] }, { - "description": "delete Tungsten-Fabric policy", + "description": "Imports a backup offering using a backup provider", "isasync": true, - "name": "deleteTungstenFabricPolicy", + "name": "importBackupOffering", "params": [ { - "description": "the Uuid of Tungsten-Fabric tag type", - "length": 255, - "name": "policyuuid", - "required": true, - "type": "string" - }, - { - "description": "the ID of zone", + "description": "The zone ID", "length": 255, "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "related": "createZone,listZones", "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the backup offering", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Whether users are allowed to create adhoc backups and backup schedules", + "length": 255, + "name": "allowuserdrivenbackups", + "required": true, "type": "boolean" - } - ] - }, - { - "description": "Updates a vm group", - "isasync": false, - "name": "updateInstanceGroup", - "params": [ + }, { - "description": "new instance group name", + "description": "the description of the backup offering", "length": 255, - "name": "name", - "required": false, + "name": "description", + "required": true, "type": "string" }, { - "description": "Instance group ID", + "description": "The backup offering ID (from backup provider side)", "length": 255, - "name": "id", - "related": "createInstanceGroup,updateInstanceGroup", + "name": "externalid", "required": true, - "type": "uuid" + "type": "string" } ], - "related": "createInstanceGroup", + "related": "listBackupOfferings,updateBackupOffering", "response": [ - {}, { - "description": "the project name of the instance group", - "name": "project", + "description": "name for the backup offering", + "name": "name", "type": "string" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "provider name", + "name": "provider", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether offering allows user driven ad-hoc/scheduled backups", + "name": "allowuserdrivenbackups", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "description for the backup offering", + "name": "description", "type": "string" }, + {}, { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "external ID on the provider side", + "name": "externalid", "type": "string" }, { - "description": "the name of the instance group", - "name": "name", + "description": "zone ID", + "name": "zoneid", "type": "string" }, { - "description": "time and date the instance group was created", + "description": "the date this backup offering was created", "name": "created", "type": "date" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "ID of the backup offering", + "name": "id", "type": "string" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the ID of the instance group", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "zone name", + "name": "zonename", "type": "string" } - ] + ], + "since": "4.14.0" }, { - "description": "Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering", + "description": "Deletes a specified domain", "isasync": true, - "name": "changeOfferingForVolume", + "name": "deleteDomain", "params": [ { - "description": "new disk offering id", + "description": "ID of domain to delete", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "name": "id", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" }, { - "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", + "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", "length": 255, - "name": "automigrate", + "name": "cleanup", "required": false, "type": "boolean" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "New maximum number of IOPS for the custom disk offering", - "length": 255, - "name": "maxiops", - "required": false, - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Verify OK to Shrink", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {} + ] + }, + { + "description": "Migrate volume", + "isasync": true, + "name": "migrateVolume", + "params": [ + { + "description": "if the volume should be live migrated when it is attached to a running vm", "length": 255, - "name": "shrinkok", + "name": "livemigrate", "required": false, "type": "boolean" }, { - "description": "New volume size in GB for the custom disk offering", + "description": "the ID of the volume", "length": 255, - "name": "size", - "required": false, - "type": "long" + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" }, { - "description": "the ID of the volume", + "description": "destination storage pool ID to migrate the volume to", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": true, "type": "uuid" + }, + { + "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.", + "length": 255, + "name": "newdiskofferingid", + "related": "", + "required": false, + "type": "uuid" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, { "description": "true if storage snapshot is supported for the volume, false otherwise", "name": "supportsstoragesnapshot", @@ -57975,68 +56784,126 @@ var preCache = `{ "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -58045,73 +56912,73 @@ var preCache = `{ "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { @@ -58120,172 +56987,135 @@ var preCache = `{ "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "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" - } - ], - "type": "set" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { "description": "the display text of the service offering for root disk", "name": "serviceofferingdisplaytext", "type": "string" }, - {}, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the path of the volume", + "name": "path", + "type": "string" }, + {}, { - "description": "size of the disk volume", - "name": "size", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, { "description": "display name of the virtual machine", "name": "vmdisplayname", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { "description": "need quiesce vm or not when taking snapshot", @@ -58293,80 +57123,65 @@ var preCache = `{ "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, - {}, { - "description": "type of the virtual machine", - "name": "vmtype", + "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" - } - ], - "since": "4.17" - }, - { - "description": "List the uploaded certificates for direct download templates", - "isasync": false, - "name": "listTemplateDirectDownloadCertificates", - "params": [ - { - "description": "the zone where certificates are uploaded", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "list direct download certificate by ID", - "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", - "required": false, - "type": "uuid" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + } + ], + "since": "3.0.0" + }, + { + "description": "create Tungsten-Fabric application policy set", + "isasync": true, + "name": "createTungstenFabricApplicationPolicySet", + "params": [ { - "description": "List by keyword", + "description": "Tungsten-Fabric application policy set name", "length": 255, - "name": "keyword", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "if set to true: include the hosts where the certificate is uploaded to", + "description": "the ID of zone", "length": 255, - "name": "listhosts", - "required": false, - "type": "boolean" + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" } ], - "related": "uploadTemplateDirectDownloadCertificate", + "related": "", "response": [ { "description": "the current status of the latest async job acting on this object", @@ -58374,181 +57189,219 @@ var preCache = `{ "type": "integer" }, { - "description": "the direct download certificate serial num", - "name": "serialnum", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, - {}, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, {}, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the direct download certificate version", - "name": "version", + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", "type": "string" }, { - "description": "the direct download certificate id", - "name": "id", - "type": "string" + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" }, + {}, { - "description": "the direct download certificate subject", - "name": "subject", - "type": "string" + "description": "list Tungsten-Fabric tag", + "name": "tag", + "type": "list" }, { - "description": "the direct download certificate issuer", - "name": "issuer", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" + } + ] + }, + { + "description": "A command to list events.", + "isasync": false, + "name": "listEvents", + "params": [ + { + "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "the direct download certificate alias", - "name": "alias", + "description": "the event type (see event types)", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "validity", - "type": "string" + "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 zone name where the certificate is uploaded", - "name": "zonename", + "description": "the type of the resource associated with the event", + "length": 255, + "name": "resourcetype", + "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the duration of the event", + "length": 255, + "name": "duration", + "required": false, + "type": "integer" }, { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" - } - ], - "since": "4.17.0" - }, - { - "description": "List ucs manager", - "isasync": false, - "name": "listUcsManagers", - "params": [ + "description": "the ID of the resource associated with the event", + "length": 255, + "name": "resourceid", + "required": false, + "since": "4.17.0", + "type": "string" + }, { - "description": "the zone id", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "", + "description": "the ID of the event", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listEvents", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the ucs manager", + "description": "the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event", "length": 255, - "name": "id", - "related": "listUcsManagers,addUcsManager", + "name": "startid", + "related": "listEvents", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "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": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" - } - ], - "related": "addUcsManager", - "response": [ + }, { - "description": "the zone ID of ucs manager", - "name": "zoneid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the url of ucs manager", - "name": "url", + "description": "the event level (INFO, WARN, ERROR)", + "length": 255, + "name": "level", + "required": false, "type": "string" }, { - "description": "the name of ucs manager", - "name": "name", - "type": "string" + "description": "true to list archived events otherwise false", + "length": 255, + "name": "archived", + "required": false, + "since": "4.19.0", + "type": "boolean" }, - {}, - {}, { - "description": "the ID of the ucs manager", - "name": "id", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the time the event was entered", + "length": 255, + "name": "entrytime", + "required": false, + "type": "integer" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Upgrades domain router to a new service offering", - "isasync": false, - "name": "changeServiceForRouter", - "params": [ + "description": "the end date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" + }, { - "description": "the service offering ID to apply to the domain router", + "description": "The state of the events", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "state", + "required": false, + "since": "4.21.0", + "type": "string" }, { - "description": "The ID of the router", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", - "required": true, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": false, "type": "uuid" } ], - "related": "destroyRouter,listRouters,listInternalLoadBalancerVMs", + "related": "", "response": [ { - "description": "role of the domain router", - "name": "role", + "description": "the type of the event (see event types)", + "name": "type", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the ID of the event", + "name": "id", + "type": "string" + }, + { + "description": "the id of the account's domain", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -58557,699 +57410,700 @@ var preCache = `{ "type": "integer" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the type of the resource", + "name": "resourcetype", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the state of the event", + "name": "state", + "type": "state" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the resource", + "name": "resourcename", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)", + "name": "username", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)", + "name": "account", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "path of the Domain the account's domain belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" + "description": "the date the event was created", + "name": "created", + "type": "date" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "whether the event has been archived or not", + "name": "archived", "type": "boolean" }, + {}, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the name of the account's domain", + "name": "domain", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the event level (INFO, WARN, ERROR)", + "name": "level", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the hostname for the router", - "name": "hostname", + "description": "a brief description of the event", + "name": "description", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "whether the event is parented", + "name": "parentid", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the id of the router", - "name": "id", + "description": "the project name of the address", + "name": "project", "type": "string" - }, + } + ] + }, + { + "description": "Lists HA providers", + "isasync": false, + "name": "listHostHAProviders", + "params": [ { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "Hypervisor type of the resource", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" - }, + } + ], + "related": "configureHAForHost,enableHAForHost,disableHAForHost", + "response": [ + {}, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "operation status", + "name": "status", + "type": "boolean" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, + {}, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.11" + }, + { + "description": "Deletes an existing Bgp Peer.", + "isasync": true, + "name": "deleteBgpPeer", + "params": [ { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "Id of the Bgp Peer", + "length": 255, + "name": "id", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {} + ], + "since": "4.20.0" + }, + { + "description": "Creates resource tag(s)", + "isasync": true, + "name": "createTags", + "params": [ { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": true, + "type": "map" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", + "length": 255, + "name": "customer", + "required": false, "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "list of resources to create the tags for", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" }, { - "description": "the version of template", - "name": "version", + "description": "type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, "type": "string" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ], + "since": "4.0.0" + }, + { + "description": "Create an Internal Load Balancer element.", + "isasync": true, + "name": "createInternalLoadBalancerElement", + "params": [ { - "description": "the gateway for the router", - "name": "gateway", + "description": "the network service provider ID of the internal load balancer element", + "length": 255, + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "required": true, + "type": "uuid" + } + ], + "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", + "response": [ + { + "description": "the physical network service provider id of the element", + "name": "nspid", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the id of the internal load balancer element", + "name": "id", "type": "string" }, + {}, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" }, { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.2.0" + }, + { + "description": "Reset api count", + "isasync": false, + "name": "resetApiLimit", + "params": [ { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, + "description": "the ID of the account whose limit to be reset", + "length": 255, + "name": "account", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + } + ], + "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ] + }, + { + "description": "Deletes a VLAN IP range.", + "isasync": false, + "name": "deleteVlanIpRange", + "params": [ { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, + "description": "the id of the VLAN IP range", + "length": 255, + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - } - ], - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, - {}, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - } + {} ] }, { - "description": "Remove an Ldap Configuration", - "isasync": false, - "name": "deleteLdapConfiguration", + "description": "Generates an alert", + "isasync": true, + "name": "generateAlert", "params": [ { - "description": "Hostname", + "description": "Pod id for which alert is generated", "length": 255, - "name": "hostname", - "required": true, - "type": "string" + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "linked domain", + "description": "Zone id for which alert is generated", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "zoneid", + "related": "createZone,listZones", "required": false, "type": "uuid" }, { - "description": "port", + "description": "Name of the alert", "length": 255, - "name": "port", - "required": false, - "type": "integer" - } - ], - "related": "addLdapConfiguration", - "response": [ - { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Alert description", + "length": 999, + "name": "description", + "required": true, + "type": "string" }, - {}, { - "description": "name of the host running the ldap server", - "name": "hostname", + "description": "Type of the alert", + "length": 255, + "name": "type", + "required": true, + "type": "short" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, { - "description": "linked domain", - "name": "domainid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], - "since": "4.2.0" + "since": "4.3" }, { - "description": "Updates the volume.", - "isasync": true, - "name": "updateVolume", + "description": "(Deprecated, use addLdapConfiguration) Configure the LDAP context for this site.", + "isasync": false, + "name": "ldapConfig", "params": [ { - "description": "the ID of the disk volume", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "hostname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The state of the volume", + "description": "Enter the password for trust store.", "length": 255, - "name": "state", + "name": "truststorepass", "required": false, - "since": "4.3", "type": "string" }, { - "description": "an optional field, whether to the display the volume to the end user or not.", + "description": "If true return current LDAP configuration", "length": 255, - "name": "displayvolume", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "The chain info of the volume", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", "length": 255, - "name": "chaininfo", + "name": "queryfilter", "required": false, - "since": "4.4", "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "Specify the distinguished name of a user with the search permission on the directory.", "length": 255, - "name": "customid", + "name": "binddn", "required": false, - "since": "4.4", "type": "string" }, { - "description": "Destination storage pool UUID for the volume", + "description": "Enter the path to trust certificates store.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "truststore", "required": false, - "since": "4.3", - "type": "uuid" + "type": "string" }, { - "description": "The path of the volume", + "description": "Specify the LDAP port if required, default is 389.", "length": 255, - "name": "path", + "name": "port", + "required": false, + "type": "integer" + }, + { + "description": "Enter the password.", + "length": 255, + "name": "bindpass", "required": false, "type": "string" }, { - "description": "new name of the volume", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", "length": 255, - "name": "name", + "name": "searchbase", "required": false, - "since": "4.16", "type": "string" + }, + { + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", + "length": 255, + "name": "ssl", + "required": false, + "type": "boolean" } ], - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "ldapRemove", "response": [ { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "DN password", + "name": "bindpass", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "Specify the LDAP port if required, default is 389", + "name": "port", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", + "name": "searchbase", + "type": "string" }, + {}, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the disk volume", - "name": "name", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", "type": "string" - }, - {}, + } + ], + "since": "3.0.0" + }, + { + "description": "List vSphere storage policies", + "isasync": false, + "name": "listVsphereStoragePolicies", + "params": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the description of the Storage Policy", + "name": "description", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the Storage Policy", + "name": "id", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the name of the Storage Policy", + "name": "name", + "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", + "type": "string" }, + {}, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Deletes a port forwarding rule", + "isasync": true, + "name": "deletePortForwardingRule", + "params": [ { - "description": "the project name of the vpn", - "name": "project", + "description": "the ID of the port forwarding rule", + "length": 255, + "name": "id", + "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "moves a vpc to another physical network", + "isasync": true, + "name": "migrateVPC", + "params": [ + { + "description": "true if previous network migration cmd failed", + "length": 255, + "name": "resume", + "required": false, + "type": "boolean" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", + "length": 255, + "name": "tiernetworkofferings", + "required": false, + "type": "map" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the ID of the vpc", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "vpc offering ID", + "length": 255, + "name": "vpcofferingid", + "related": "updateVPCOffering,listVPCOfferings", + "required": true, + "type": "uuid" + } + ], + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "response": [ + { + "description": "the owner of the VPC", + "name": "account", + "type": "string" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -59257,177 +58111,275 @@ var preCache = `{ "type": "boolean" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, + {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, + {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "AS NUMBER", + "name": "asnumber", "type": "long" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if VPC is region level", + "name": "regionlevelvpc", "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the name of the VPC", + "name": "name", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "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": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", + "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -59436,149 +58388,296 @@ var preCache = `{ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the status of the volume", - "name": "status", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, - {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" + } + ], + "since": "4.11.0" + }, + { + "description": "Deletes a global load balancer rule.", + "isasync": true, + "name": "deleteGlobalLoadBalancerRule", + "params": [ + { + "description": "the ID of the global load balancer rule", + "length": 255, + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {} + ] + }, + { + "description": "update an annotation visibility.", + "isasync": false, + "name": "updateAnnotationVisibility", + "params": [ { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the annotation is visible for admins only", + "length": 255, + "name": "adminsonly", + "required": true, + "type": "boolean" + }, + { + "description": "the id of the annotation", + "length": 255, + "name": "id", + "required": true, + "type": "string" + } + ], + "related": "addAnnotation,listAnnotations,removeAnnotation", + "response": [ + { + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, + {}, + {}, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + { + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" + }, + { + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "4.16" }, { - "description": "Creates a Project role", + "description": "Updates a configuration.", "isasync": false, - "name": "createProjectRole", + "name": "updateConfiguration", "params": [ { - "description": "creates a project role with this unique name", + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "the value of the configuration", + "length": 4096, + "name": "value", + "required": false, + "type": "string" + }, + { + "description": "the ID of the Account to update the parameter value for corresponding account", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the configuration", "length": 255, "name": "name", "required": true, "type": "string" }, { - "description": "ID of project where role is being created", + "description": "the ID of the Image Store to update the parameter value for corresponding image store", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, + "name": "imagestoreuuid", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", + "required": false, "type": "uuid" }, { - "description": "The description of the Project role", + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "description", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "the ID of the Zone to update the parameter value for corresponding zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Domain to update the parameter value for corresponding domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" } ], - "related": "updateProjectRole", + "related": "listConfigurations", "response": [ { - "description": "the description of the role", + "description": "the type of the configuration value", + "name": "type", + "type": "string" + }, + { + "description": "the default value of the configuration", + "name": "defaultvalue", + "type": "string" + }, + { + "description": "the value of the configuration", + "name": "id", + "type": "long" + }, + { + "description": "the description of the configuration", "name": "description", "type": "string" }, + {}, + { + "description": "the component of the configuration", + "name": "component", + "type": "string" + }, { - "description": "the id of the project", - "name": "projectid", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the configuration", + "name": "name", + "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "description": "the group of the configuration", + "name": "group", + "type": "string" + }, + { + "description": "the value of the configuration", + "name": "value", + "type": "string" + }, + { + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", + "type": "string" + }, + { + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, { @@ -59587,291 +58686,291 @@ var preCache = `{ "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" + "description": "the possible options of the configuration value", + "name": "options", + "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the category of the configuration", + "name": "category", + "type": "string" + }, + { + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" + }, {} - ], - "since": "4.15.0" + ] }, { - "description": "Lists traffic types of a given physical network.", - "isasync": false, - "name": "listTrafficTypes", + "description": "Configures HA for a host", + "isasync": true, + "name": "configureHAForHost", "params": [ { - "description": "List by keyword", + "description": "HA provider", "length": 255, - "name": "keyword", - "required": false, + "name": "provider", + "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "ID of the host", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "hostid", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], - "related": "listNetworkServiceProviders", + "related": "enableHAForHost,disableHAForHost", "response": [ { - "description": "the provider name", - "name": "name", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "operation status", + "name": "status", + "type": "boolean" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", + "description": "if host HA is enabled for the host", + "name": "haenable", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, + {}, { - "description": "uuid of the network provider", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], - "since": "3.0.0" + "since": "4.11" }, { - "description": "Updates account information for the authenticated user", + "description": "Lists volume stats", "isasync": false, - "name": "updateAccount", + "name": "listVolumesUsageHistory", "params": [ { - "description": "Network domain for the account's networks; empty string will update domainName with NULL value", + "description": "List by keyword", "length": 255, - "name": "networkdomain", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Account UUID", + "description": "", "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "New name for the account", + "description": "the IDs of the volumes, mutually exclusive with id.", "length": 255, - "name": "newname", + "name": "ids", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, - "type": "string" + "type": "list" }, { - "description": "Details for the account used to store specific parameters", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "accountdetails", + "name": "startdate", "required": false, - "type": "map" + "type": "date" }, { - "description": "The UUID of the domain where the account exists", + "description": "the ID of the volume.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "id", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, "type": "uuid" }, { - "description": "The UUID of the dynamic role to set for the account", + "description": "", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Current account name", + "description": "name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" + }, + { + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" } ], - "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", + "related": "", "response": [ + {}, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the ID of the volume", + "name": "id", "type": "string" }, + {}, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the account", + "description": "the name of the volume", "name": "name", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" - }, + "description": "the list of VM stats", + "name": "stats", + "type": "list" + } + ], + "since": "4.18.0" + }, + { + "description": "Dedicates a Public IP range to an account", + "isasync": false, + "name": "dedicatePublicIpRange", + "params": [ { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": false, + "type": "uuid" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "domain ID of the account owning a VLAN", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "account who will own the VLAN", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, + "description": "the id of the VLAN IP range", + "length": 255, + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", + "required": true, + "type": "uuid" + } + ], + "related": "createVlanIpRange,updateVlanIpRange", + "response": [ { - "description": "the name of the role", - "name": "rolename", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the domain name of the VLAN IP range", + "name": "domain", + "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -59879,666 +58978,653 @@ var preCache = `{ "type": "integer" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "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" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, + {}, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the end ip of the VLAN IP range", + "name": "endip", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "indicates to which provider the IP range is dedicated to", + "name": "provider", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" - }, + } + ] + }, + { + "description": "Adds API permissions to a project role", + "isasync": false, + "name": "createProjectRolePermission", + "params": [ { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "ID of project where project role permission is to be created", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The rule permission, allow or deny. Default: deny.", + "length": 255, + "name": "permission", + "required": true, + "type": "string" }, - {}, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": true, + "type": "uuid" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "The description of the role permission", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "The API name or wildcard rule such as list*", + "length": 255, + "name": "rule", + "required": true, "type": "string" - }, + } + ], + "related": "listProjectRolePermissions", + "response": [ { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the state of the account", - "name": "state", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the ID of the project role permission", + "name": "id", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", + "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the ID of the project", + "name": "projectid", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, {}, { - "description": "the id of the account", - "name": "id", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, + {}, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", + "type": "string" + } + ], + "since": "4.15.0" + }, + { + "description": "Deletes an empty Bucket.", + "isasync": false, + "name": "deleteBucket", + "params": [ { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, + "description": "The ID of the Bucket", + "length": 255, + "name": "id", + "related": "createBucket,listBuckets", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.19.0" }, { - "description": "Adds secondary storage.", + "description": "Create a console endpoint to connect to a VM console", "isasync": false, - "name": "addSecondaryStorage", + "name": "createConsoleEndpoint", "params": [ { - "description": "the URL for the secondary storage", + "description": "(optional) extra security token, valid when the extra validation is enabled", "length": 255, - "name": "url", - "required": true, + "name": "token", + "required": false, "type": "string" }, { - "description": "the Zone ID for the secondary storage", + "description": "ID of the VM", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, "type": "uuid" } ], - "related": "listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "related": "", "response": [ { - "description": "the name of the image store", - "name": "name", - "type": "string" - }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "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 Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, {}, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "true if the console endpoint is generated properly", + "name": "success", + "type": "boolean" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "details in case of an error", + "name": "details", "type": "string" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "the console websocket options", + "name": "websocket", + "type": "consoleendpointwebsocketresponse" }, {}, { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, - { - "description": "the provider name of the image store", - "name": "providername", + "description": "the console url", + "name": "url", "type": "string" - }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" } - ] + ], + "since": "4.18.0" }, { - "description": "Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.", + "description": "Updates a project role permission and/or order", "isasync": false, - "name": "updateVirtualMachine", + "name": "updateProjectRolePermission", "params": [ { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "ruleorder", + "related": "listProjectRolePermissions", "required": false, - "type": "map" + "type": "list" }, { - "description": "true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting", + "description": "Project Role permission rule id", "length": 255, - "name": "isdynamicallyscalable", + "name": "projectrolepermissionid", + "related": "listProjectRolePermissions", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list of security group ids to be applied on the virtual machine.", + "description": "Rule permission, can be: allow or deny", "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", + "name": "permission", "required": false, - "type": "list" + "type": "string" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "ID of the project role", "length": 255, - "name": "displayvm", - "required": false, - "type": "boolean" + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": true, + "type": "uuid" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "ID of project where project role permission is to be updated", "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18", - "type": "map" - }, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the userdata", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "since": "4.18", - "type": "uuid" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", - "length": 255, - "name": "name", - "required": false, - "since": "4.4", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", - "required": false, - "since": "4.12", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Adds user to a project", + "isasync": true, + "name": "addUserToProject", + "params": [ { - "description": "group of the virtual machine", + "description": "email ID of user to which invitation to the project is going to be sent", "length": 255, - "name": "group", + "name": "email", "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", + "description": "ID of the project to add the user to", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" }, { - "description": "instance name of the user vm", + "description": "ID of the project role", "length": 255, - "name": "instancename", + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { - "description": "user generated name", + "description": "Name of the user to be added to the project", "length": 255, - "name": "displayname", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "description": "Project role type to be assigned to the user - Admin/Regular", "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup", + "name": "roletype", "required": false, - "type": "list" + "type": "string" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "true if high-availability is enabled for the virtual machine, false otherwise", - "length": 255, - "name": "haenable", - "required": false, + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "The ID of the virtual machine", + "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.14" + }, + { + "description": "Disables HA cluster-wide", + "isasync": true, + "name": "disableHAForCluster", + "params": [ + { + "description": "ID of the cluster", "length": 255, - "name": "id", - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "clusterid", + "related": "addCluster,updateCluster", "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": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, - "since": "4.16.0", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.11" + }, + { + "description": "delete Tungsten-Fabric firewall policy", + "isasync": true, + "name": "deleteTungstenFabricFirewallPolicy", + "params": [ + { + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "cleanupdetails", - "required": false, + "name": "firewallpolicyuuid", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "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" }, + {} + ] + }, + { + "description": "Recovers a virtual machine.", + "isasync": false, + "name": "recoverVirtualMachine", + "params": [ { - "description": "the ID of the OS type that best represents this VM.", + "description": "The ID of the virtual machine", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, + "name": "id", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, "type": "uuid" } ], - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "response": [ { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "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" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, { "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "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 egress rules associated with the security group", "name": "egressrule", "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -60547,93 +59633,93 @@ var preCache = `{ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -60642,71 +59728,81 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ - { - "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 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 code for the ICMP message response", @@ -60714,47 +59810,67 @@ var preCache = `{ "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, + { + "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", + "description": "the id of the security group rule", + "name": "ruleid", + "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -60763,28 +59879,23 @@ var preCache = `{ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], @@ -60792,79 +59903,90 @@ var preCache = `{ } ], "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" } ], "type": "set" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "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 ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { "description": "NICs of the VNF appliance", @@ -60872,18 +59994,13 @@ var preCache = `{ "type": "list" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -60891,73 +60008,73 @@ var preCache = `{ "name": "nic", "response": [ { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -60966,8 +60083,18 @@ var preCache = `{ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -60976,38 +60103,38 @@ var preCache = `{ "type": "boolean" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -61016,19 +60143,14 @@ var preCache = `{ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "the isolated private VLAN if available", @@ -61036,85 +60158,75 @@ var preCache = `{ "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" } ], "type": "set" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the name of the affinity group", - "name": "name", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { @@ -61123,9 +60235,9 @@ var preCache = `{ "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 type of the affinity group", @@ -61137,6 +60249,11 @@ var preCache = `{ "name": "projectid", "type": "string" }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, { "description": "the project name of the affinity group", "name": "project", @@ -61145,65 +60262,117 @@ var preCache = `{ ], "type": "set" }, + {}, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, - {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the 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": "tag value", + "name": "value", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { @@ -61212,232 +60381,219 @@ var preCache = `{ "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, - {}, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, - {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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 name of the host for the virtual machine", - "name": "hostname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, + {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { @@ -61446,969 +60602,934 @@ var preCache = `{ "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" } ] }, { - "description": "Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC)", - "isasync": true, - "name": "createIpv6FirewallRule", + "description": "Resets network permissions.", + "isasync": false, + "name": "resetNetworkPermissions", "params": [ { - "description": "type of the ICMP message being sent", + "description": "the network ID", "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { - "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", - "length": 255, - "name": "traffictype", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "destcidrlist", - "required": false, - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "The network of the VM the Ipv6 firewall rule will be created for", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.17.0" + }, + { + "description": "Updates an existing Bgp Peer.", + "isasync": true, + "name": "updateBgpPeer", + "params": [ + { + "description": "The IPv4 address of the Bgp Peer.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "name": "ipaddress", + "required": false, + "type": "string" }, { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "The password of the Bgp Peer.", "length": 255, - "name": "protocol", - "required": true, + "name": "password", + "required": false, "type": "string" }, { - "description": "error code for this ICMP message", + "description": "The IPv6 address of the Bgp Peer.", "length": 255, - "name": "icmpcode", + "name": "ip6address", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ending port of Ipv6 firewall rule", + "description": "The AS number of the Bgp Peer.", "length": 255, - "name": "endport", + "name": "asnumber", "required": false, - "type": "integer" + "type": "long" }, { - "description": "the starting port of Ipv6 firewall rule", + "description": "Id of the Bgp Peer", "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "name": "id", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "required": true, + "type": "uuid" }, { - "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "BGP peer details in key/value pairs.", "length": 255, - "name": "cidrlist", + "name": "details", "required": false, - "type": "list" + "type": "map" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details are removed for this resource; if false or not set, no action)", "length": 255, - "name": "fordisplay", + "name": "cleanupdetails", "required": false, "type": "boolean" } ], - "related": "listPortForwardingRules,updatePortForwardingRule,updateIpv6FirewallRule", + "related": "createBgpPeer,listBgpPeers,dedicateBgpPeer,releaseBgpPeer", "response": [ { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the port forwarding rule", + "description": "id of the bgp peer", "name": "id", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, + {}, + {}, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "list" + "description": "IPv4 address of bgp peer", + "name": "ipaddress", + "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobbs have been completed. Triggers an immediate shutdown if forced", - "isasync": false, - "name": "triggerShutdown", + "description": "update Tungsten-Fabric loadbalancer health monitor", + "isasync": true, + "name": "updateTungstenFabricLBHealthMonitor", "params": [ { - "description": "the uuid of the management server", + "description": "loadbalancer health monitor http method", "length": 255, - "name": "managementserverid", - "related": "", - "required": true, - "type": "uuid" - } - ], - "related": "prepareForShutdown", - "response": [ - { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" - }, - {}, - { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" - }, - { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "name": "httpmethodtype", + "required": false, + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "loadbalancer health monitor retry", + "length": 255, + "name": "retry", + "required": true, "type": "integer" }, - {}, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "loadbalancer health monitor interval", + "length": 255, + "name": "interval", + "required": true, + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "loadbalancer health monitor expected code", + "length": 255, + "name": "expectedcode", + "required": false, "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Disables an account", - "isasync": true, - "name": "disableAccount", - "params": [ + }, { - "description": "If true, only lock the account; else disable the account", + "description": "loadbalancer health monitor type", "length": 255, - "name": "lock", + "name": "type", "required": true, - "type": "boolean" + "type": "string" }, { - "description": "Disables specified account.", + "description": "loadbalancer health monitor timeout", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "timeout", + "required": true, + "type": "integer" }, { - "description": "Account id", + "description": "the ID of lb rule", "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", - "required": false, + "name": "lbruleid", + "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "required": true, "type": "uuid" }, { - "description": "Disables specified account in this domain.", + "description": "loadbalancer health monitor url path", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "urlpath", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "createAccount,enableAccount,listAccounts,listAccounts", + "related": "", "response": [ - {}, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the health monitor timeout", + "name": "timeout", + "type": "int" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the health monitor ID", + "name": "id", "type": "long" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the health monitor expected code", + "name": "expectedcode", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, {}, + {}, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "the health monitor interval", + "name": "interval", + "type": "int" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the health monitor http method", + "name": "httpmethod", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the health monitor retry", + "name": "retry", + "type": "int" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the health monitor url path", + "name": "urlpath", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the health monitor type", + "name": "type", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the health monitor UUID", + "name": "uuid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Release the dedication for host", + "isasync": true, + "name": "releaseDedicatedHost", + "params": [ { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + {}, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the network domain", - "name": "networkdomain", + "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": "Accepts or declines project invitation", + "isasync": true, + "name": "updateProjectInvitation", + "params": [ { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" }, { - "description": "the name of the account", - "name": "name", + "description": "list invitations for specified account; this parameter has to be specified with domainId", + "length": 255, + "name": "token", + "required": false, "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" + "description": "id of the project to join", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "if true, accept the invitation, decline if false. True by default", + "length": 255, + "name": "accept", + "required": false, + "type": "boolean" }, { - "description": "the state of the account", - "name": "state", + "description": "account that is joining the project", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, + } + ], + "response": [ + {}, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "This is supposed to revert a volume snapshot. This command is only supported with KVM so far", + "isasync": true, + "name": "revertSnapshot", + "params": [ { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, + "description": "The ID of the snapshot", + "length": 255, + "name": "id", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", + "required": true, + "type": "uuid" + } + ], + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "response": [ { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "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", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the user name", - "name": "username", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user email address", - "name": "email", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the type of the role", - "name": "roletype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the domain name of the user", + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the domain ID of the user", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" }, + {}, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - } - ] - }, - { - "description": "Lists domains and provides detailed information for listed domains", - "isasync": false, - "name": "listDomains", - "params": [ - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "List domains by domain level.", - "length": 255, - "name": "level", - "required": false, - "type": "integer" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "flag to display the resource icon for domains", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List domain by domain ID.", - "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "List domain by domain name.", - "length": 255, + "description": "name of the snapshot", "name": "name", - "required": false, "type": "string" }, { - "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", - "length": 255, - "name": "details", - "required": false, - "type": "list" - } - ], - "related": "listDomainChildren,listDomains", - "response": [ - { - "description": "the ID of the domain", - "name": "id", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, + {}, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" + } + ] + }, + { + "description": "Updates a condition for VM auto scaling", + "isasync": true, + "name": "updateCondition", + "params": [ + { + "description": "Value for which the Counter will be evaluated with the Operator selected.", + "length": 255, + "name": "threshold", + "required": true, + "type": "long" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the ID of the condition.", + "length": 255, + "name": "id", + "related": "listConditions", + "required": true, + "type": "uuid" + }, + { + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "length": 255, + "name": "relationaloperator", + "required": true, "type": "string" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the state of the domain", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.18.0" + }, + { + "description": "Lists Regions", + "isasync": false, + "name": "listRegions", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the path of the domain", - "name": "path", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "List Region by region name.", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List Region by region ID.", + "length": 255, + "name": "id", + "required": false, + "type": "integer" + } + ], + "related": "addRegion,updateRegion", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the ID of the region", + "name": "id", + "type": "integer" }, + {}, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the end point of the region", + "name": "endpoint", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the name of the region", + "name": "name", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" }, + {}, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" + } + ] + }, + { + "description": "Attempts Migration of a system virtual machine to the host specified.", + "isasync": true, + "name": "migrateSystemVm", + "params": [ + { + "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", + "length": 255, + "name": "autoselect", + "required": false, + "since": "4.16.0", + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": true, + "type": "uuid" + }, + { + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.16.0", + "type": "uuid" + }, + { + "description": "destination Host ID to migrate VM to", + "length": 255, + "name": "hostid", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + } + ], + "related": "startSystemVm,changeServiceForSystemVm", + "response": [ + { + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" + }, + { + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { @@ -62417,483 +61538,796 @@ var preCache = `{ "type": "integer" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the ID of the system VM", + "name": "id", + "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the date when this domain was created", + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" + }, + { + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "CPU arch of the system VM", + "name": "arch", + "type": "string" + }, + { + "description": "the date and time the system VM was created", "name": "created", "type": "date" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, + {}, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "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 last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" } ] }, { - "description": "Updates a network", - "isasync": true, - "name": "updateNetwork", + "description": "List the counters for VM auto scaling", + "isasync": false, + "name": "listCounters", "params": [ { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "Name of the counter.", "length": 255, - "name": "hideipaddressusage", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", + "description": "Network provider of the counter.", "length": 255, - "name": "ip6dns1", + "name": "provider", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "Setting this to true will cause a forced network update,", + "description": "List by keyword", "length": 255, - "name": "forced", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider", + "description": "", "length": 255, - "name": "updateinsequence", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "an optional field, whether to the display the network to the end user or not.", + "description": "", "length": 255, - "name": "displaynetwork", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the network", + "description": "ID of the Counter.", "length": 255, "name": "id", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, + "related": "createCounter,listCounters", + "required": false, "type": "uuid" }, { - "description": "Force update even if CIDR type is different", + "description": "Source of the counter.", "length": 255, - "name": "changecidr", + "name": "source", "required": false, + "type": "string" + } + ], + "related": "createCounter", + "response": [ + { + "description": "zone id of counter", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Provider of the counter.", + "name": "provider", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the Counter", + "name": "id", + "type": "string" + }, + { + "description": "Name of the counter.", + "name": "name", + "type": "string" + }, + {}, + { + "description": "Value in case of snmp or other specific counters.", + "name": "value", + "type": "string" + }, + { + "description": "Source of the counter.", + "name": "source", + "type": "string" + } + ] + }, + { + "description": "Configures an Internal Load Balancer element.", + "isasync": true, + "name": "configureInternalLoadBalancerElement", + "params": [ + { + "description": "Enables/Disables the Internal Load Balancer element", + "length": 255, + "name": "enabled", + "required": true, "type": "boolean" }, { - "description": "the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", + "description": "the ID of the internal lb provider", "length": 255, - "name": "dns2", - "required": false, - "since": "4.18.0", + "name": "id", + "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", + "required": true, + "type": "uuid" + } + ], + "related": "listInternalLoadBalancerElements", + "response": [ + {}, + {}, + { + "description": "the physical network service provider id of the element", + "name": "nspid", "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "the id of the internal load balancer element", + "name": "id", + "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "remove Tungsten-Fabric tag", + "isasync": true, + "name": "removeTungstenFabricTag", + "params": [ + { + "description": "the uuid of networks", "length": 255, - "name": "privatemtu", + "name": "networkuuid", "required": false, - "since": "4.18.0", - "type": "integer" + "type": "list" }, { - "description": "network domain", + "description": "the ID of zone", "length": 255, - "name": "networkdomain", - "required": false, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric tag", + "length": 255, + "name": "taguuid", + "required": true, "type": "string" }, { - "description": "the new name for the network", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "name", + "name": "applicationpolicysetuuid", "required": false, "type": "string" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "sourcenatipaddress", + "name": "policyuuid", "required": false, - "since": "4.19", "type": "string" }, { - "description": "the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone", + "description": "the uuid of nics", "length": 255, - "name": "dns1", + "name": "nicuuid", "required": false, - "since": "4.18.0", - "type": "string" + "type": "list" }, { - "description": "the new display text for the network", + "description": "the uuid of vms", "length": 255, - "name": "displaytext", + "name": "vmuuid", "required": false, + "type": "list" + } + ], + "related": "createTungstenFabricTag,listTungstenFabricTag,applyTungstenFabricTag", + "response": [ + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", + "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": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" + }, + {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" + }, + { + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" + }, + { + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" + }, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" + }, + {} + ] + }, + { + "description": "Lists all available virtual router elements.", + "isasync": false, + "name": "listVirtualRouterElements", + "params": [ + { + "description": "List by keyword", "length": 255, - "name": "guestvmcidr", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", + "description": "list virtual router elements by id", "length": 255, - "name": "ip6dns2", + "name": "id", + "related": "configureVirtualRouterElement,listVirtualRouterElements", "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" }, { - "description": "network offering ID", + "description": "", "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list virtual router elements by network service provider id", + "length": 255, + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": false, "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "", "length": 255, - "name": "customid", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" + }, + { + "description": "list network offerings by enabled state", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" } ], - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "related": "configureVirtualRouterElement", "response": [ { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "Enabled/Disabled the service provider", + "name": "enabled", "type": "boolean" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - {}, - { - "description": "the domain id of the network owner", + "description": "the domain ID associated with the provider", "name": "domainid", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the domain associated with the provider", + "name": "domain", + "type": "string" }, + {}, { - "description": "the project name of the address", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, + {}, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the id of the router", + "name": "id", "type": "string" - }, + } + ] + }, + { + "description": "Deletes an existing IPv4 subnet for guest network.", + "isasync": true, + "name": "deleteIpv4SubnetForGuestNetwork", + "params": [ { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "Id of the guest network IPv4 subnet", + "length": 255, + "name": "id", + "related": "createIpv4SubnetForGuestNetwork", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ], + "since": "4.20.0" + }, + { + "description": "Delete the custom action", + "isasync": false, + "name": "deleteCustomAction", + "params": [ { - "description": "the id of the network", + "description": "uuid of the custom action", + "length": 255, "name": "id", + "related": "addCustomAction,listCustomActions", + "required": false, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.21.0" + }, + { + "description": "Creates a routing firewall rule in the given network in ROUTED mode", + "isasync": true, + "name": "createRoutingFirewallRule", + "params": [ + { + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, "type": "boolean" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": true, "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": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "The network of the VM the firewall rule will be created for", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "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 starting port of firewall rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "destcidrlist", + "required": false, + "type": "list" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, + { + "description": "the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the ending port of firewall rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + } + ], + "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "response": [ + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, - {}, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, + {}, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { @@ -62902,12 +62336,12 @@ var preCache = `{ "type": "integer" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { @@ -62916,38 +62350,43 @@ var preCache = `{ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -62956,737 +62395,488 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, + {}, { - "description": "related to what other network configuration", - "name": "related", + "description": "the state of the rule", + "name": "state", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "link a cloudstack account to a group or OU in ldap", + "isasync": false, + "name": "linkAccountToLdap", + "params": [ + { + "description": "type of the ldap name. GROUP or OU, defaults to GROUP", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "domain admin username in LDAP ", + "length": 255, + "name": "admin", + "required": false, "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "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" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "Creates the account under the specified role.", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": false, + "since": "4.19.1", + "type": "uuid" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "The id of the domain that is to contain the linked account.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "length": 255, + "name": "accounttype", + "required": false, + "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "name of the account, it will be created if it does not exist", + "length": 255, + "name": "account", + "required": true, "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "ldapdomain", + "required": true, "type": "string" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, + } + ], + "related": "", + "response": [ { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "id of the Domain which is linked to LDAP", + "name": "domainid", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", "type": "string" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "Type of the account to auto import", + "name": "accounttype", + "type": "int" }, + {}, + {}, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "Domain Admin accountId that is created", + "name": "accountid", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", "type": "string" - }, + } + ], + "since": "4.11.0" + }, + { + "description": "Disables out-of-band management for a host", + "isasync": true, + "name": "disableOutOfBandManagementForHost", + "params": [ { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" - }, + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", + "response": [ { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, + {}, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "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 domain name of the network owner", - "name": "domain", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - } - ] - }, - { - "description": "List Usage Types", - "isasync": false, - "name": "listUsageTypes", - "params": [], - "related": "", - "response": [ + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, { - "description": "description of usage type", - "name": "description", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, - {}, { - "description": "usage type", - "name": "usagetypeid", - "type": "integer" + "description": "the operation result", + "name": "status", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" } - ] + ], + "since": "4.9.0" }, { - "description": "Resets the UserData for virtual machine. The virtual machine must be in a \"Stopped\" state.", - "isasync": false, - "name": "resetUserDataForVirtualMachine", + "description": "Cancel host status from 'Degraded'. Host will transit back to status 'Enabled'.", + "isasync": true, + "name": "cancelHostAsDegraded", "params": [ { - "description": "an optional project for the virtual machine", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the userdata", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "type": "map" - }, - { - "description": "The ID of the virtual machine", + "description": "host ID", "length": 255, "name": "id", - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" - }, - { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, - "type": "string" - }, - { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "response": [ { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "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 number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - } - ], - "type": "set" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the admin that annotated this host", + "name": "username", "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, - {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, + {}, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the hypervisor on which the template runs", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the host hypervisor", "name": "hypervisor", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "The ID of extension for this cluster", + "name": "extensionid", "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", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + {}, + { + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { @@ -63695,284 +62885,317 @@ var preCache = `{ "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "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 last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, - {}, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "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 type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the name of the virtual machine", + "description": "the name of the host", "name": "name", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, + {}, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the host", + "name": "id", "type": "string" + } + ], + "since": "4.16.0.0" + }, + { + "description": "Releases an AS Number back to the pool", + "isasync": false, + "name": "releaseASNumber", + "params": [ + { + "description": "the AS Number to be released", + "length": 255, + "name": "asnumber", + "required": true, + "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ], + "since": "4.20.0" + }, + { + "description": "Creates a security group", + "isasync": false, + "name": "createSecurityGroup", + "params": [ + { + "description": "the description of the security group", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "Create security group for project", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the security group. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "name of the security group", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + } + ], + "related": "updateSecurityGroup", + "response": [ + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { - "description": "the domain name of the security group", - "name": "domain", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project name of the group", - "name": "project", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -63981,13 +63204,13 @@ var preCache = `{ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -63996,414 +63219,419 @@ var preCache = `{ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { "description": "customer associated with the tag", "name": "customer", "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" } ], "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "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": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the 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 protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "tag key name", + "name": "key", "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" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "account owning the security group rule", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "account owning the security group rule", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, + {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the security group", + "name": "name", "type": "string" }, + {}, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "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": "resource type", + "name": "resourcetype", + "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the account owning the security group", + "name": "account", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Removes a VM from any existing backup offering", + "isasync": true, + "name": "removeVirtualMachineFromBackupOffering", + "params": [ { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, + "description": "Whether to force remove VM from the backup offering that may also delete VM backups.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + } + ], + "response": [ + {}, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ], - "since": "4.18.0" + "since": "4.14.0" }, { - "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", - "isasync": true, - "name": "deleteTemplate", + "description": "List network visibility and all accounts that have permissions to view this network.", + "isasync": false, + "name": "listNetworkPermissions", "params": [ { - "description": "Force delete a template.", - "length": 255, - "name": "forced", - "required": false, - "since": "4.9+", - "type": "boolean" - }, - { - "description": "the ID of zone of the template", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the template", + "description": "Lists network permission by network ID", "length": 255, - "name": "id", - "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" } ], + "related": "", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the project the network is available for", + "name": "project", + "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of account the network is available for", + "name": "accountid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network ID", + "name": "networkid", "type": "string" }, - {} - ] - }, - { - "description": "Lists all network ACLs", - "isasync": false, - "name": "listNetworkACLLists", - "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the ID of the domain to which the network belongs", + "name": "domainid", + "type": "string" }, { - "description": "list network ACLs by VPC ID", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the account the network is available for", + "name": "account", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the domain to which the network belongs", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the ID of project the network is available for", + "name": "projectid", "type": "string" }, + {} + ], + "since": "4.17.0" + }, + { + "description": "Lists site 2 site vpn gateways", + "isasync": false, + "name": "listVpnGateways", + "params": [ { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, @@ -64412,20 +63640,28 @@ var preCache = `{ "type": "boolean" }, { - "description": "list network ACLs by specified name", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "name", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list network ACLs by network ID", + "description": "id of the vpn gateway", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "createVpnGateway,listVpnGateways,updateVpnGateway", "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 resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, @@ -64442,332 +63678,264 @@ var preCache = `{ "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, "type": "uuid" }, { - "description": "Lists network ACL with the specified ID.", + "description": "", "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "id of vpc", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" } ], - "related": "createNetworkACLList", + "related": "createVpnGateway,updateVpnGateway", "response": [ { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the ID of the ACL", - "name": "id", + "description": "the public IP address", + "name": "publicip", "type": "string" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the Name of the ACL", - "name": "name", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "is ACL for display to the regular user", + "description": "is vpn gateway for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "Description of the ACL", - "name": "description", - "type": "string" - } - ] - }, - { - "description": "Archives (moves) a snapshot on primary storage to secondary storage", - "isasync": true, - "name": "archiveSnapshot", - "params": [ - { - "description": "The ID of the snapshot", - "length": 255, + "description": "the vpn gateway ID", "name": "id", - "related": "copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", - "required": true, - "type": "uuid" - } - ], - "related": "copySnapshot,revertSnapshot,listSnapshots", - "response": [ - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, - { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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": "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" - } - ], - "type": "set" - }, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the owner", + "name": "account", "type": "string" }, + {}, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, + } + ] + }, + { + "description": "Add Netris Provider to CloudStack", + "isasync": false, + "name": "addNetrisProvider", + "params": [ { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "Netris provider URL", + "length": 255, + "name": "netrisurl", + "required": true, "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "Netris provider name", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "Netris Tenant name", + "length": 255, + "name": "tenantname", + "required": true, "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "Netris Site name", + "length": 255, + "name": "sitename", + "required": true, "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "Password to login into Netris", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "Username to login into Netris", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "Netris tag for vNets", + "length": 255, + "name": "netristag", + "required": true, "type": "string" - }, + } + ], + "related": "listNetrisProviders,deleteNetrisProvider", + "response": [ { - "description": "name of the disk volume", - "name": "volumename", + "description": "Netris Provider name", + "name": "name", "type": "string" }, - {}, - { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - {}, - { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "Zone ID to which the Netris Provider is associated with", + "name": "zoneid", "type": "string" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" - }, - { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "Netris provider uuid", + "name": "uuid", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "Netris Tag for vNets", + "name": "netristag", "type": "string" }, + {}, + {}, { - "description": "the project name of the snapshot", - "name": "project", + "description": "Zone name to which the Netris Provider is associated with", + "name": "zonename", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "Netris Admin tenant name", + "name": "tenantname", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "Netris Provider URL", + "name": "netrisurl", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Netris Provider site", + "name": "sitename", "type": "string" } - ] + ], + "since": "4.21.0" }, { - "description": "Deletes a VPC", - "isasync": true, - "name": "deleteVPC", + "description": "Moves a user to another account in the same domain.", + "isasync": false, + "name": "moveUser", "params": [ { - "description": "the ID of the VPC", + "description": "Moves the user under the specified account. If no account name is specified, it is necessary to provide an account id.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Moves the user under the specified account. If no account id is specified, it is necessary to provide an account name.", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "id of the user to be moved.", "length": 255, "name": "id", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", "required": true, "type": "uuid" } @@ -64778,65 +63946,123 @@ var preCache = `{ "name": "success", "type": "boolean" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } - ] + ], + "since": "4.11" }, { - "description": "Updates site to site vpn local gateway", + "description": "Releases host reservation.", "isasync": true, - "name": "updateVpnGateway", + "name": "releaseHostReservation", "params": [ { - "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": "id of customer gateway", + "description": "the host ID", "length": 255, "name": "id", - "related": "createVpnGateway,listVpnGateways,updateVpnGateway", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" - }, - { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, + } + ], + "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" + } + ] + }, + { + "description": "Create site to site vpn connection", + "isasync": true, + "name": "createVpnConnection", + "params": [ + { + "description": "connection is passive or not", + "length": 255, + "name": "passive", + "required": false, + "type": "boolean" + }, + { + "description": "id of the customer gateway", + "length": 255, + "name": "s2scustomergatewayid", + "related": "createVpnCustomerGateway,updateVpnCustomerGateway", + "required": true, + "type": "uuid" + }, + { + "description": "an optional field, whether to the display the vpn to the end user or not", + "length": 255, "name": "fordisplay", "required": false, "since": "4.4", "type": "boolean" + }, + { + "description": "id of the vpn gateway", + "length": 255, + "name": "s2svpngatewayid", + "related": "createVpnGateway,updateVpnGateway", + "required": true, + "type": "uuid" } ], - "related": "createVpnGateway,listVpnGateways", + "related": "updateVpnConnection", "response": [ + {}, { - "description": "the project name", - "name": "project", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + { + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "the connection ID", + "name": "id", "type": "string" }, { @@ -64845,29 +64071,43 @@ var preCache = `{ "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", + "description": "State of vpn connection", + "name": "passive", "type": "boolean" }, - {}, { - "description": "the vpn gateway ID", - "name": "id", + "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": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { @@ -64875,122 +64115,129 @@ var preCache = `{ "name": "publicip", "type": "string" }, - {}, { - "description": "the project id", - "name": "projectid", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the project name", + "name": "project", "type": "string" - } - ], - "since": "4.4" - }, - { - "description": "Releases a dedicated guest vlan range to the system", - "isasync": true, - "name": "releaseDedicatedGuestVlanRange", - "params": [ + }, { - "description": "the ID of the dedicated guest vlan range", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the owner", + "name": "account", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", "type": "boolean" }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" + }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" } ] }, { - "description": "Deletes security group", + "description": "lists network that are using a brocade vcs switch", "isasync": false, - "name": "deleteSecurityGroup", + "name": "listBrocadeVcsDeviceNetworks", "params": [ { - "description": "The ID of the security group. Mutually exclusive with id parameter", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the account of the security group. Must be specified with domain ID", + "description": "brocade vcs switch ID", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "vcsdeviceid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the domain ID of account owning the security group", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the project of the security group", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "The ID of the security group. Mutually exclusive with name parameter", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createSecurityGroup", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" }, { @@ -64999,482 +64246,370 @@ var preCache = `{ "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, - {}, - {} - ] - }, - { - "description": "Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool", - "isasync": true, - "name": "migrateVirtualMachine", - "params": [ { - "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", - "length": 255, - "name": "autoselect", - "required": false, - "since": "4.16.0", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "Destination Host ID to migrate VM to.", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "type": "uuid" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the network domain", + "name": "networkdomain", "type": "string" }, + {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "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 read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - } - ], - "type": "set" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "AS NUMBER", + "name": "asnumber", "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "The IPv4 routing type of network", + "name": "ip4routing", "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": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the project name of the address", + "name": "project", "type": "string" }, - {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the list of services", + "name": "service", "response": [ { - "description": "the project name of the affinity group", - "name": "project", - "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 domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + } + ], + "type": "list" }, { - "description": "the name of the affinity group", + "description": "the service name", "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 project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "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 account owning the affinity group", - "name": "account", - "type": "string" } ], - "type": "set" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "type": "list" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, + {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -65483,999 +64618,1290 @@ var preCache = `{ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "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": "Guest vm Boot Mode", - "name": "bootmode", + "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 ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "related to what other network configuration", + "name": "related", + "type": "string" + } + ] + }, + { + "description": "Deletes a vGPU profile from the system", + "isasync": false, + "name": "deleteGpuDevice", + "params": [ + { + "description": "comma separated list of IDs of the GPU device", + "length": 255, + "name": "ids", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", + "required": true, + "type": "list" + } + ], + "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 group ID of the virtual machine", - "name": "groupid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.21.0" + }, + { + "description": "Lists Webhook deliveries", + "isasync": false, + "name": "listWebhookDeliveries", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "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": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "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 key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - } - ], - "type": "set" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "The end date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having end date equal to or before the specified date will be listed.", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "The event type of the Webhook delivery", + "length": 255, + "name": "eventtype", + "required": false, "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "The ID of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": false, + "type": "uuid" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "The ID of the Webhook", + "length": 255, + "name": "webhookid", + "related": "createWebhook,listWebhookDeliveries", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "The start date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having start date equal to or after the specified date will be listed.", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, - {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, + "description": "The ID of the Webhook delivery", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "createWebhook", + "response": [ { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", + "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "The scope of the Webhook", + "name": "scope", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "The secret key for the Webhook", + "name": "secretkey", "type": "string" }, + {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The description of the Webhook", + "name": "description", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "The state of the Webhook", + "name": "state", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "The ID of the Webhook", + "name": "id", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "The name of the Webhook", + "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": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the date when this virtual machine was created", + "description": "The date when this Webhook was created", "name": "created", "type": "date" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "The account associated with the Webhook", + "name": "account", "type": "string" }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - } - ] + {} + ], + "since": "4.20.0" }, { - "description": "Deletes a Kubernetes cluster", + "description": "Dedicates a host.", "isasync": true, - "name": "deleteKubernetesSupportedVersion", + "name": "dedicateHost", "params": [ { - "description": "the ID of the Kubernetes supported version", + "description": "the ID of the containing domain", "length": 255, - "name": "id", - "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the ID of the host to update", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], + "related": "listDedicatedHosts", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the name of the host", + "name": "hostname", + "type": "string" + }, + { + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the Account ID of the host", + "name": "accountid", + "type": "string" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + {}, + { + "description": "the domain ID of the host", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + } ] }, { - "description": "Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it.", - "isasync": true, - "name": "createTemplate", + "description": "Lists storage access groups", + "isasync": false, + "name": "listStorageAccessGroups", "params": [ { - "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", + "description": "List by keyword", "length": 255, - "name": "snapshotid", - "related": "copySnapshot,revertSnapshot,listSnapshots", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "", "length": 255, - "name": "isdynamicallyscalable", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "true if this template is a public template, false otherwise", + "description": "Name of the Storage access group", "length": 255, - "name": "ispublic", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal", + "description": "", "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "since": "4.19.0", - "type": "uuid" + "description": "List of Zones in the Storage Access Group", + "name": "zones", + "type": "listresponse" }, { - "description": "true if the template requires HVM, false otherwise", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "description": "List of Storage Pools in the Storage Access Group", + "name": "storagepools", + "type": "listresponse" }, { - "description": "The display text of the template, defaults to the 'name'.", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "List of Hosts in the Storage Access Group", + "name": "hosts", + "type": "listresponse" + }, + { + "description": "List of Pods in the Storage Access Group", + "name": "pods", + "type": "listresponse" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the storage access group", + "name": "name", "type": "string" }, { - "description": "the zone for the template. Can be specified with snapshot only", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.19.0", - "type": "uuid" + "description": "List of Clusters in the Storage Access Group", + "name": "clusters", + "type": "listresponse" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the ID of the storage access group", + "name": "id", + "type": "string" }, + {} + ], + "since": "4.21.0" + }, + { + "description": "Adds the GloboDNS external host", + "isasync": true, + "name": "addGloboDnsHost", + "params": [ { - "description": "create template for the project", + "description": "the Physical Network ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, "type": "uuid" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "Password for GloboDNS", "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "name": "password", + "required": true, + "type": "string" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "Username for GloboDNS", "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" + "name": "username", + "required": true, + "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "GloboDNS url", "length": 255, - "name": "account", - "required": false, - "since": "4.19.0", + "name": "url", + "required": true, + "type": "string" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", - "length": 2048, - "name": "url", - "required": false, + "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.5.0" + }, + { + "description": "Logs out the user", + "isasync": false, + "name": "logout", + "params": [], + "related": "", + "response": [ + { + "description": "Response description", + "name": "description", "type": "string" }, { - "description": "the name of the template", + "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": "Imports a role based on provided map of rule permissions", + "isasync": false, + "name": "importRole", + "params": [ + { + "description": "Creates a role with this unique name", "length": 255, "name": "name", "required": true, "type": "string" }, { - "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", + "description": "The description of the role", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "32 or 64 bit", + "description": "Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false.", "length": 255, - "name": "bits", + "name": "forced", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing", "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "name": "rules", + "required": true, + "type": "map" }, { - "description": "the ID of the OS Type that best represents the OS of this template.", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": true, - "type": "uuid" + "name": "ispublic", + "required": false, + "type": "boolean" }, { - "description": "the tag for this template.", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "templatetag", + "name": "type", "required": false, "type": "string" } ], - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "createRole,listRoles,updateRole", "response": [ + { + "description": "the name of the role", + "name": "name", + "type": "string" + }, + {}, {}, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the state of the role", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the description of the role", + "name": "description", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.15.0" + }, + { + "description": "Restart a Shared FileSystem", + "isasync": true, + "name": "restartSharedFileSystem", + "params": [ + { + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "is cleanup required", + "length": 255, + "name": "cleanup", + "required": false, + "type": "boolean" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ], + "since": "4.20.0" + }, + { + "description": "Lists network serviceproviders for a given physical network.", + "isasync": false, + "name": "listNetworkServiceProviders", + "params": [ { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "list providers by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list providers by name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "addNetworkServiceProvider,listTrafficTypes", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the provider name", + "name": "name", + "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, {}, + {} + ], + "since": "3.0.0" + }, + { + "description": "delete Tungsten-Fabric tag type", + "isasync": true, + "name": "deleteTungstenFabricTagType", + "params": [ { - "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 ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the ID of Tungsten-Fabric tag type", + "length": 255, + "name": "tagtypeuuid", + "required": true, "type": "string" - }, + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {}, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Deletes an Object Storage Pool", + "isasync": false, + "name": "deleteObjectStoragePool", + "params": [ { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, + "description": "The Object Storage ID.", + "length": 255, + "name": "id", + "related": "addObjectStoragePool,updateObjectStoragePool", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template ID", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.19.0" + }, + { + "description": "Delete Netscaler Control Center", + "isasync": false, + "name": "deleteNetscalerControlCenter", + "params": [ + { + "description": "Netscaler Control Center ID", + "length": 255, "name": "id", + "related": "", + "required": true, "type": "string" - }, + } + ], + "response": [ { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "checksum of the template", - "name": "checksum", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the template display text", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ] + }, + { + "description": "Deletes a detached disk volume.", + "isasync": false, + "name": "deleteVolume", + "params": [ + { + "description": "The ID of the disk volume", + "length": 255, + "name": "id", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "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": "Updates an existing secondary storage selector.", + "isasync": false, + "name": "updateSecondaryStorageSelector", + "params": [ + { + "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", + "length": 65535, + "name": "heuristicrule", + "required": true, + "type": "string" + }, + { + "description": "The unique identifier of the secondary storage selector.", + "length": 255, + "name": "id", + "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", + "required": true, + "type": "uuid" + } + ], + "related": "listSecondaryStorageSelectors", + "response": [ + { + "description": "ID of the heuristic.", + "name": "id", + "type": "string" + }, + { + "description": "Description of the heuristic.", + "name": "description", + "type": "string" + }, + { + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", + "type": "string" + }, + { + "description": "Name of the heuristic.", + "name": "name", + "type": "string" + }, + { + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "When the heuristic was created.", + "name": "created", + "type": "date" + }, + {}, + { + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Enables a user account", + "isasync": false, + "name": "enableUser", + "params": [ + { + "description": "Enables user by user ID.", + "length": 255, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" + } + ], + "related": "createUser,disableUser,getUser,listUsers,lockUser", + "response": [ + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + {}, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the user email address", + "name": "email", + "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": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + } + ] + }, + { + "description": "Suspends a project", + "isasync": true, + "name": "suspendProject", + "params": [ + { + "description": "id of the project to be suspended", + "length": 255, + "name": "id", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" + } + ], + "related": "activateProject,createProject", + "response": [ + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -66484,221 +65910,203 @@ var preCache = `{ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the template name", - "name": "name", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" }, { - "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", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", + "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - } - ] - }, - { - "description": "list baremetal rack configuration", - "isasync": false, - "name": "listBaremetalRct", - "params": [ + "description": "the total number of buckets available to this project", + "name": "bucketavailable", + "type": "string" + }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the name of the project", + "name": "name", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" - } - ], - "related": "addBaremetalRct", - "response": [ + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, - {}, { - "description": "url", - "name": "url", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "id of rct", - "name": "id", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" - } - ] - }, - { - "description": "Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself.", - "isasync": true, - "name": "uploadCustomCertificate", - "params": [ + }, { - "description": "A name / alias for the certificate.", - "length": 255, - "name": "name", - "required": false, + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, { - "description": "The certificate to be uploaded.", - "length": 65535, - "name": "certificate", - "required": true, + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "DNS domain suffix that the certificate is granted for.", - "length": 255, - "name": "domainsuffix", - "required": true, + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "The private key for the attached certificate.", - "length": 65535, - "name": "privatekey", - "required": false, + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3", - "length": 255, - "name": "id", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -66706,143 +66114,156 @@ var preCache = `{ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "message of the certificate upload operation", - "name": "message", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, - {} - ] - }, - { - "description": "Lists dedicated clusters.", - "isasync": false, - "name": "listDedicatedClusters", - "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the total number of backups available to this project", + "name": "backupavailable", "type": "string" }, { - "description": "the ID of the cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "list dedicated clusters by affinity group", - "length": 255, - "name": "affinitygroupid", - "related": "", - "required": false, - "type": "uuid" + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the name of the account associated with the cluster. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the ID of the domain associated with the cluster", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", + "type": "long" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", "type": "integer" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, + { + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" + }, {}, { - "description": "the name of the cluster", - "name": "clustername", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the domain ID of the cluster", + "description": "the id of the project", + "name": "id", + "type": "string" + }, + { + "description": "the domain id the project belongs to", "name": "domainid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, - {} - ] - }, - { - "description": "Lists available certificate authority providers in CloudStack", - "isasync": false, - "name": "listCAProviders", - "params": [ { - "description": "List CA service provider by name", - "length": 255, - "name": "name", - "required": false, + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" } ], + "since": "3.0.0" + }, + { + "description": "Get API limit count for the caller", + "isasync": false, + "name": "getApiLimit", + "params": [], "related": "", "response": [ + { + "description": "currently allowed number of apis", + "name": "apiAllowed", + "type": "int" + }, { "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", @@ -66850,100 +66271,160 @@ var preCache = `{ }, {}, { - "description": "the CA service provider name", - "name": "name", + "description": "number of api already issued", + "name": "apiIssued", + "type": "int" + }, + { + "description": "seconds left to reset counters", + "name": "expireAfter", + "type": "long" + }, + {}, + { + "description": "the account uuid of the api remaining count", + "name": "accountid", "type": "string" }, { - "description": "the description of the CA service provider", - "name": "description", + "description": "the account name of the api remaining count", + "name": "account", "type": "string" } - ], - "since": "4.11.0" + ] }, { - "description": "Delete site to site vpn customer gateway", + "description": "Deletes a storage network IP Range.", "isasync": true, - "name": "deleteVpnCustomerGateway", + "name": "deleteStorageNetworkIpRange", "params": [ { - "description": "id of customer gateway", + "description": "the uuid of the storage network ip range", "length": 255, "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "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": "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" - } - ] + {} + ], + "since": "3.0.0" }, { - "description": "Lists all port forwarding rules for an IP address.", + "description": "Adds a VMware datacenter to specified zone", "isasync": false, - "name": "listPortForwardingRules", + "name": "addVmwareDc", "params": [ { - "description": "Lists rule with the specified ID.", + "description": "The password for specified username.", "length": 255, - "name": "id", - "related": "listPortForwardingRules,updatePortForwardingRule,updateIpv6FirewallRule", + "name": "password", "required": false, + "type": "string" + }, + { + "description": "The Zone ID.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "Name of VMware datacenter to be added to specified zone.", "length": 255, - "name": "tags", - "required": false, - "type": "map" + "name": "name", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", "length": 255, - "name": "keyword", - "required": false, + "name": "vcenter", + "required": true, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "The Username required to connect to resource.", "length": 255, - "name": "account", + "name": "username", "required": false, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "The VMware vCenter name/ip", + "name": "vcenter", + "type": "string" }, + {}, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "The VMware Datacenter ID", + "name": "id", + "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": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" + }, + { + "description": "The VMware Datacenter name", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "Updates Ipv6 firewall rule with specified ID", + "isasync": true, + "name": "updateIpv6FirewallRule", + "params": [ + { + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "listall", + "name": "cidrlist", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", "length": 255, "name": "fordisplay", "required": false, @@ -66951,91 +66432,74 @@ var preCache = `{ "type": "boolean" }, { - "description": "list port forwarding rules for certain network", + "description": "the ID of the ipv6 firewall rule", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.3", + "name": "id", + "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "required": true, "type": "uuid" }, { - "description": "the ID of IP address of the port forwarding services", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "", + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "page", + "name": "endport", "required": false, "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "startport", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "type of the ICMP message being sent", "length": 255, - "name": "pagesize", + "name": "icmptype", "required": false, "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "traffictype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "isrecursive", + "name": "protocol", "required": false, - "type": "boolean" - } - ], - "related": "updatePortForwardingRule,updateIpv6FirewallRule", - "response": [ - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - {}, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + } + ], + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "response": [ { - "description": "the state of the rule", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -67044,29 +66508,24 @@ var preCache = `{ "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { @@ -67074,8 +66533,18 @@ var preCache = `{ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -67084,23 +66553,23 @@ var preCache = `{ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -67108,196 +66577,224 @@ var preCache = `{ "name": "domain", "type": "string" }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, { "description": "the VM name for the port forwarding rule", "name": "virtualmachinename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the rule", + "name": "state", + "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, + {}, { "description": "the ID of the port forwarding rule", "name": "id", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" } ] }, { - "description": "Allocates IP addresses in respective Pod of a Zone", + "description": "Updates ISO permissions", "isasync": false, - "name": "acquirePodIpAddress", + "name": "updateIsoPermissions", "params": [ { - "description": "the ID of the zone", + "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "string" + "name": "accounts", + "required": false, + "type": "list" }, { - "description": "Pod ID", + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "podid", - "related": "createZone,updateZone,listZones,listZones", + "name": "projectids", + "related": "activateProject,createProject", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ + "type": "list" + }, { - "description": "CIDR of the Pod", - "name": "cidr", + "description": "permission operator (add, remove, reset)", + "length": 255, + "name": "op", + "required": false, "type": "string" }, { - "description": "the ID of the pod the IP address", - "name": "id", - "type": "long" + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" }, - {}, { - "description": "Allocated IP address", - "name": "ipaddress", - "type": "string" + "description": "true for featured template/iso, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" }, { - "description": "MAC address of the pod the IP", - "name": "hostmac", - "type": "long" + "description": "the template ID", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "description": "true for public template/iso, false for private templates/isos", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + } + ], + "response": [ {}, { - "description": "the ID of the pod the IP address belongs to", - "name": "podid", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the ID of the nic", - "name": "nicid", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Gateway for Pod ", - "name": "gateway", - "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": "Enables out-of-band management for a cluster", + "description": "Deletes VPC offering", "isasync": true, - "name": "enableOutOfBandManagementForCluster", + "name": "deleteVPCOffering", "params": [ { - "description": "the ID of the cluster", + "description": "the ID of the VPC offering", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", "required": true, "type": "uuid" } ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", "response": [ { - "description": "the operation result description", - "name": "description", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the host", - "name": "hostid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the operation result", - "name": "status", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Deletes a network ACL", + "isasync": true, + "name": "deleteNetworkACL", + "params": [ { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" - }, + "description": "the ID of the network ACL", + "length": 255, + "name": "id", + "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "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", @@ -67305,36 +66802,24 @@ var preCache = `{ }, {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" } - ], - "since": "4.9.0" + ] }, { - "description": "list Tungsten-Fabric network", + "description": "List Autonomous Systems Number Ranges", "isasync": false, - "name": "listTungstenFabricNetwork", + "name": "listASNRanges", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the uuid of Tungsten-Fabric network", + "description": "the zone ID", "length": 255, - "name": "networkuuid", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "List by keyword", @@ -67344,19 +66829,11 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "", @@ -67369,13 +66846,14 @@ var preCache = `{ "related": "", "response": [ { - "description": "Tungsten-Fabric network uuid", - "name": "uuid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Zone ID", + "name": "zoneid", "type": "string" }, { @@ -67384,1587 +66862,1103 @@ var preCache = `{ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the AS Number Range", + "name": "id", + "type": "string" }, { - "description": "Tungsten-Fabric network name", - "name": "name", - "type": "string" + "description": "Start AS Number", + "name": "startasn", + "type": "long" + }, + { + "description": "Created date", + "name": "created", + "type": "date" }, {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "End AS Number", + "name": "endasn", "type": "long" - }, - {} - ] + } + ], + "since": "4.20.0" }, { - "description": "Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them.", - "isasync": false, - "name": "updateTemplatePermissions", + "description": "create Tungsten-Fabric tag", + "isasync": true, + "name": "createTungstenFabricTag", "params": [ { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" - }, - { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "projectids", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "list" - }, - { - "description": "permission operator (add, remove, reset)", + "description": "Tungsten-Fabric tag type", "length": 255, - "name": "op", - "required": false, + "name": "tagtype", + "required": true, "type": "string" }, { - "description": "true for public template/iso, false for private templates/isos", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, - { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "Tungsten-Fabric tag value", "length": 255, - "name": "accounts", - "required": false, - "type": "list" + "name": "tagvalue", + "required": true, + "type": "string" }, { - "description": "the template ID", + "description": "the ID of zone", "length": 255, - "name": "id", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "zoneid", + "related": "createZone,listZones", "required": true, "type": "uuid" - }, - { - "description": "true for featured template/iso, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" } ], + "related": "listTungstenFabricTag,applyTungstenFabricTag", "response": [ + { + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" + }, {}, + { + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" + }, + { + "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 vm", + "name": "vm", + "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" } ] }, { - "description": "List traffic monitor Hosts.", - "isasync": false, - "name": "listTrafficMonitors", + "description": "Adds an OpenDyalight controler", + "isasync": true, + "name": "addOpenDaylightController", "params": [ { - "description": "zone Id", + "description": "Username to access the OpenDaylight API", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "username", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "Credential to access the OpenDaylight API", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "password", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "Api URL of the OpenDaylight Controller.", "length": 255, - "name": "keyword", - "required": false, + "name": "url", + "required": true, "type": "string" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" } ], - "related": "addTrafficMonitor", + "related": "deleteOpenDaylightController", "response": [ { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "device id of the controller", + "name": "id", "type": "string" }, {}, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the ID of the external firewall", - "name": "id", + "description": "the url of the controller api", + "name": "url", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the name assigned to the controller", + "name": "name", "type": "string" } ] }, { - "description": "Resets the password for virtual machine. The virtual machine must be in a \"Stopped\" state and the template must already support this feature for this command to take effect. [async]", - "isasync": true, - "name": "resetPasswordForVirtualMachine", + "description": "Creates a Zone.", + "isasync": false, + "name": "createZone", "params": [ { - "description": "The new password of the virtual machine. If null, a random password will be generated for the VM.", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "password", + "name": "ip6dns2", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "The ID of the virtual machine", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "id", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - {}, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "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 read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "name": "localstorageenabled", + "required": false, + "type": "boolean" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the first DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns1", + "required": false, "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "true if the zone is an edge zone, false otherwise", + "length": 255, + "name": "isedge", + "required": false, + "since": "4.18.0", + "type": "boolean" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the ID of the containing domain, null for public zones", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the second internal DNS for the Zone", + "length": 255, + "name": "internaldns2", + "required": false, "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Allocation state of this Zone for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Network domain name for the networks in the zone", + "length": 255, + "name": "domain", + "required": false, "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the first DNS for the Zone", + "length": 255, + "name": "dns1", + "required": true, "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network is security group enabled, false otherwise", + "length": 255, + "name": "securitygroupenabled", + "required": false, "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the second DNS for the Zone", + "length": 255, + "name": "dns2", + "required": false, "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the first internal DNS for the Zone", + "length": 255, + "name": "internaldns1", + "required": true, "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the Zone", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the guest CIDR address for the Zone", + "length": 255, + "name": "guestcidraddress", + "required": false, "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "network type of the zone, can be Basic or Advanced", + "length": 255, + "name": "networktype", + "required": true, "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, + "description": "comma separated list of storage access groups for the hosts in the zone", + "length": 255, + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", + "type": "list" + } + ], + "related": "listZones", + "response": [ { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { - "description": "VNF details", - "name": "vnfdetails", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", "type": "map" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the 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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the 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 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 id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "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": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, + {}, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the Pod ID", + "name": "podid", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the capacity name", + "name": "name", + "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "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": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" } ], - "type": "set" + "type": "list" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "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": "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 domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - {}, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "External network provider if any", + "name": "provider", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" }, - {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true, if routed network/vpc is enabled", + "name": "routedmodeenabled", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Used GPUs in the Zone", + "name": "gpuused", + "type": "long" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", "type": "boolean" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, + {}, { - "description": "the project id of the vm", - "name": "projectid", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" } ] }, { - "description": "Updates a port forwarding rule. Only the private port and the virtual machine can be updated.", - "isasync": true, - "name": "updatePortForwardingRule", + "description": "Lists all children domains belonging to a specified domain", + "isasync": false, + "name": "listDomainChildren", "params": [ { - "description": "the private start port of the port forwarding rule", + "description": "", "length": 255, - "name": "privateport", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", "length": 255, - "name": "customid", + "name": "isrecursive", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" }, { - "description": "the ID of the virtual machine for the port forwarding rule", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the port forwarding rule", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list children domain by parent domain ID.", "length": 255, "name": "id", - "related": "updatePortForwardingRule,updateIpv6FirewallRule", - "required": true, - "since": "4.4", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "flag to display the resource icon for domains", "length": 255, - "name": "fordisplay", + "name": "showicon", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "the private end port of the port forwarding rule", + "description": "List by keyword", "length": 255, - "name": "privateendport", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "VM guest nic Secondary ip address for the port forwarding rule", + "description": "list children domains by name", "length": 255, - "name": "vmguestip", + "name": "name", "required": false, - "since": "4.5", "type": "string" } ], - "related": "updateIpv6FirewallRule", + "related": "createDomain,listDomains,listDomains,moveDomain", "response": [ { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of gpus the domain can own", + "name": "gpulimit", + "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 owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, + { + "description": "the total number of backups available to this domain", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the total number of gpus owned by domain", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the name of the domain", + "name": "name", + "type": "string" + }, + { + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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 domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", + "type": "string" }, {}, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the ID of the port forwarding rule", + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the ID of the domain", "name": "id", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the state of the domain", + "name": "state", "type": "string" - } - ] - }, - { - "description": "Lists Brocade VCS Switches", - "isasync": false, - "name": "listBrocadeVcsDevices", - "params": [ + }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" }, { - "description": "Brocade VCS switch ID", - "length": 255, - "name": "vcsdeviceid", - "related": "listBrocadeVcsDevices", - "required": false, - "type": "uuid" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" + }, { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, - {}, { - "description": "name of the provider", - "name": "provider", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the principal switch Ip address", - "name": "hostname", + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", "type": "string" }, { - "description": "device name", - "name": "brocadedevicename", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" } ] }, { - "description": "link an existing cloudstack domain to group or OU in ldap", + "description": "Returns an encrypted password for the VM", "isasync": false, - "name": "linkDomainToLdap", + "name": "getVMPassword", "params": [ { - "description": "name of the group or OU in LDAP", + "description": "The ID of the virtual machine", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "id", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "domain admin username in LDAP ", - "length": 255, - "name": "admin", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the group or OU in LDAP", - "length": 255, - "name": "ldapdomain", - "required": false, + "description": "The base64 encoded encrypted password of the VM", + "name": "encryptedpassword", "type": "string" }, + {} + ] + }, + { + "description": "Assign load balancer rule or list of load balancer rules to a global load balancer rules.", + "isasync": true, + "name": "assignToGlobalLoadBalancerRule", + "params": [ { - "description": "type of the ldap name. GROUP or OU", + "description": "Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'", "length": 255, - "name": "type", - "required": true, - "type": "string" + "name": "gslblbruleweightsmap", + "required": false, + "type": "map" }, { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "description": "the ID of the global load balancer rule", "length": 255, - "name": "accounttype", + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "The id of the domain which has to be linked to LDAP.", + "description": "the list load balancer rules that will be assigned to global load balancer rule", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "loadbalancerrulelist", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": true, - "type": "uuid" + "type": "list" } ], - "related": "linkAccountToLdap", "response": [ { "description": "the current status of the latest async job acting on this object", @@ -68972,144 +67966,124 @@ var preCache = `{ "type": "integer" }, { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", - "type": "string" - }, - { - "description": "Domain Admin accountId that is created", - "name": "accountid", - "type": "string" - }, - { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - { - "description": "Type of the account to auto import", - "name": "accounttype", - "type": "int" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "type of the name in LDAP which is linked to the domain", - "name": "type", - "type": "string" - }, - {} - ], - "since": "4.6.0" + } + ] }, { - "description": "Acquires and associates a public IP to an account.", - "isasync": true, - "name": "associateIpAddress", + "description": "Adds S3 Image Store", + "isasync": false, + "name": "addImageStoreS3", "params": [ { - "description": "the account to associate with this IP address", + "description": "S3 endpoint", "length": 255, - "name": "account", - "required": false, + "name": "endpoint", + "required": true, "type": "string" }, { - "description": "The network this IP address should be associated to.", + "description": "Connection TTL (milliseconds)", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "connectionttl", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the VPC you want the IP address to be associated with", + "description": "Socket timeout (milliseconds)", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "sockettimeout", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the domain to associate with this IP address", + "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "s3signer", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", + "description": "Name of the storage bucket", "length": 255, - "name": "isportable", - "required": false, - "type": "boolean" + "name": "bucket", + "required": true, + "type": "string" }, { - "description": "IP Address to be associated", + "description": "S3 secret key", "length": 255, - "name": "ipaddress", - "required": false, + "name": "secretkey", + "required": true, "type": "string" }, { - "description": "region ID from where portable IP is to be associated.", + "description": "Maximum number of times to retry on error", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "maxerrorretry", "required": false, "type": "integer" }, { - "description": "Deploy VM for the project", + "description": "Connection timeout (milliseconds)", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "connectiontimeout", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "an optional field, whether to the display the IP to the end user or not", + "description": "Whether TCP keep-alive is used", "length": 255, - "name": "fordisplay", + "name": "usetcpkeepalive", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "the ID of the availability zone you want to acquire an public IP address from", + "description": "Use HTTPS instead of HTTP", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "usehttps", "required": false, - "type": "uuid" + "type": "boolean" + }, + { + "description": "S3 access key", + "length": 255, + "name": "accesskey", + "required": true, + "type": "string" } ], - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", "response": [ { - "description": "the project name of the address", - "name": "project", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, + {}, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -69117,687 +68091,805 @@ var preCache = `{ "type": "integer" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "the name of the image store", + "name": "name", + "type": "string" }, + {}, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the url of the image store", + "name": "url", "type": "string" }, - {}, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "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 total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" - }, - {}, + } + ], + "since": "4.7.0" + }, + { + "description": "Upload a certificate for HTTPS direct template download on KVM hosts", + "isasync": false, + "name": "uploadTemplateDirectDownloadCertificate", + "params": [ { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "Hypervisor type", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" + "description": "(optional) the host ID to upload certificate", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" + "description": "Zone to upload certificate", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "public IP address id", - "name": "id", + "description": "Name for the uploaded certificate", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the list of resource tags associated with ip address", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "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" - }, - { - "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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "SSL certificate", + "length": 65535, + "name": "certificate", + "required": true, "type": "string" - }, + } + ], + "related": "listTemplateDirectDownloadCertificates", + "response": [ { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the direct download certificate issuer", + "name": "issuer", "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the zone name where the certificate is uploaded", + "name": "zonename", "type": "string" }, - { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the direct download certificate subject", + "name": "subject", "type": "string" }, + {}, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "the direct download certificate version", + "name": "version", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the direct download certificate id", + "name": "id", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", - "type": "string" - } - ] - }, - { - "description": "Get the SF Volume Access Group IDs", - "isasync": false, - "name": "getSolidFireVolumeAccessGroupIds", - "params": [ - { - "description": "Cluster UUID", - "length": 255, - "name": "clusterid", - "required": true, + "description": "the direct download certificate alias", + "name": "alias", "type": "string" }, { - "description": "Storage Pool UUID", - "length": 255, - "name": "storageid", - "required": true, + "description": "the direct download certificate issuer", + "name": "validity", "type": "string" } ], - "related": "", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "SolidFire Volume Access Group Ids", - "name": "solidFireVolumeAccessGroupIds", - "type": "long[]" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] + "since": "4.11.0" }, { - "description": "Setup the 2FA for the user.", - "isasync": false, - "name": "setupUserTwoFactorAuthentication", + "description": "Import unmanaged virtual machine from a given cluster.", + "isasync": true, + "name": "importUnmanagedInstance", "params": [ { - "description": "optional: the id of the user for which 2FA has to be disabled", + "description": "import instance for the project", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "projectid", + "related": "activateProject,createProject", "required": false, "type": "uuid" }, { - "description": "Enabled by default, provide false to disable 2FA", + "description": "VM nic to network id mapping using keys nic and network", "length": 255, - "name": "enable", + "name": "nicnetworklist", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "two factor authentication code", + "description": "the name of the instance as it is known to the hypervisor", "length": 255, - "name": "provider", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the user ID", - "name": "id", + "name": "name", + "required": true, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" }, { - "description": "secret code that needs to be registered with authenticator", - "name": "secretcode", - "type": "string" - } - ], - "since": "4.18.0" - }, - { - "description": "Delete site to site vpn connection", - "isasync": true, - "name": "deleteVpnConnection", - "params": [ - { - "description": "id of vpn connection", + "description": "the cluster ID", "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections", + "name": "clusterid", + "related": "addCluster,updateCluster", "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" - } - ] - }, - { - "description": "Creates a ACL rule in the given network (the network has to belong to VPC)", - "isasync": true, - "name": "createNetworkACL", - "params": [ { - "description": "type of the ICMP message being sent", + "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", "length": 255, - "name": "icmptype", + "name": "forced", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "scl entry action, allow or deny", + "description": "the display name of the instance", "length": 255, - "name": "action", + "name": "displayname", "required": false, "type": "string" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, - { - "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", + "description": "the host name of the instance", "length": 255, - "name": "traffictype", + "name": "hostname", "required": false, "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "used to specify the custom parameters.", "length": 255, - "name": "fordisplay", + "name": "details", "required": false, - "since": "4.4", - "type": "boolean" + "type": "map" }, { - "description": "The network of the VM the ACL will be created for", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the starting port of ACL", + "description": "import instance to the domain specified", "length": 255, - "name": "startport", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "cidrlist", + "name": "datadiskofferinglist", "required": false, - "type": "list" + "type": "map" }, { - "description": "The number of the ACL item, its ordering", + "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", "length": 255, - "name": "number", + "name": "migrateallowed", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "The network of the VM the ACL will be created for", + "description": "the service offering for the virtual machine", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, "type": "uuid" }, { - "description": "error code for this ICMP message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" - }, - { - "description": "A description indicating why the ACL rule is required.", - "length": 255, - "name": "reason", - "required": false, - "type": "string" - }, - { - "description": "the ending port of ACL", + "description": "VM nic to ip address mapping using keys nic, ip4Address", "length": 255, - "name": "endport", + "name": "nicipaddresslist", "required": false, - "type": "integer" + "type": "map" } ], - "related": "updateNetworkACLItem,moveNetworkAclItem", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "response": [ { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "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 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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "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 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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "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": "id of the resource", + "name": "resourceid", + "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": "tag value", + "name": "value", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the list of resource tags associated with the network ACLs", - "name": "tags", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", + "description": "the account owning the affinity group", "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], - "type": "list" + "type": "set" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "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", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" - } - ] - }, - { - "description": "Resets the SSH Key for virtual machine. The virtual machine must be in a \"Stopped\" state. [async]", - "isasync": true, - "name": "resetSSHKeyForVirtualMachine", - "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an optional project for the ssh key", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "name of the ssh key pair used to login to the virtual machine", - "length": 255, - "name": "keypair", - "required": false, + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "names of the ssh key pairs to be used to login to the virtual machine", - "length": 255, - "name": "keypairs", - "required": false, - "since": "4.17", - "type": "list" - } - ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { "description": "the password (if exists) of the virtual machine", @@ -69805,97 +68897,42 @@ var preCache = `{ "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, { "description": "the isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, { "description": "the ID of the corresponding network", "name": "networkid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -69904,23 +68941,43 @@ var preCache = `{ "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "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", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -69929,18 +68986,23 @@ var preCache = `{ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { @@ -69949,19 +69011,24 @@ var preCache = `{ "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { "description": "public IP address associated with this nic via Static nat rule", @@ -69969,57 +69036,42 @@ var preCache = `{ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" } ], "type": "set" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Guest vm Boot Type", @@ -70027,291 +69079,216 @@ var preCache = `{ "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, - {}, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, + {}, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "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 write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", "type": "date" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "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", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, - {}, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, { "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { "description": "OS name of the vm", @@ -70319,372 +69296,44 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "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 ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, - {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the 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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "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": "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": "id of the resource", - "name": "resourceid", - "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" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "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": "Base64 string containing the user data", - "name": "userdata", + "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", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "the list of resource tags associated", @@ -70696,23 +69345,23 @@ var preCache = `{ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -70731,324 +69380,302 @@ var preCache = `{ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" - } - ], - "type": "set" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" }, { - "description": "the project ID of the affinity group", + "description": "the project id the tag belongs to", "name": "projectid", "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" } ], "type": "set" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - } - ] - }, - { - "description": "Lists site to site vpn customer gateways", - "isasync": false, - "name": "listVpnCustomerGateways", - "params": [ - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "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": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "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, + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "id of the customer gateway", - "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways", - "required": false, - "type": "uuid" - } - ], - "related": "createVpnCustomerGateway", - "response": [ - { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" }, - {}, { - "description": "the owner", - "name": "account", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "name of the customer gateway", - "name": "name", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + } + ], + "since": "4.14.0" + }, + { + "description": "Unmanage a GPU device", + "isasync": false, + "name": "unmanageGpuDevice", + "params": [ { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "comma separated list of IDs of the GPU device", + "length": 255, + "name": "ids", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", + "required": true, + "type": "list" + } + ], + "response": [ + {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.21.0" }, { - "description": "Deletes a management network IP range. This action is only allowed when no IPs in this range are allocated.", + "description": "Creates a physical network", "isasync": true, - "name": "deleteManagementNetworkIpRange", + "name": "createPhysicalNetwork", "params": [ { - "description": "The ending IP address.", + "description": "Tag the physical network", "length": 255, - "name": "endip", - "required": true, - "type": "string" + "name": "tags", + "required": false, + "type": "list" }, { - "description": "The starting IP address.", + "description": "the isolation method for the physical network[VLAN/L3/GRE]", "length": 255, - "name": "startip", + "name": "isolationmethods", + "required": false, + "type": "list" + }, + { + "description": "the name of the physical network", + "length": 255, + "name": "name", "required": true, "type": "string" }, { - "description": "The vlan id the ip range sits on", + "description": "the VLAN for the physical network", "length": 255, "name": "vlan", - "required": true, + "required": false, "type": "string" }, { - "description": "UUID of POD, where the IP range belongs to.", + "description": "the speed for the physical network[1G/10G]", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "networkspeed", + "required": false, + "type": "string" + }, + { + "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", + "length": 255, + "name": "broadcastdomainrange", + "required": false, + "type": "string" + }, + { + "description": "the Zone ID for the physical network", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "domain ID of the account owning a physical network", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" } ], + "related": "listPhysicalNetworks,updatePhysicalNetwork", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "zone id of the physical network", + "name": "zoneid", + "type": "string" + }, + { + "description": "the speed of the physical network", + "name": "networkspeed", + "type": "string" + }, + { + "description": "name of the physical network", + "name": "name", + "type": "string" + }, + { + "description": "isolation methods", + "name": "isolationmethods", + "type": "string" + }, + { + "description": "zone name of the physical network", + "name": "zonename", + "type": "string" + }, + { + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", + "type": "string" + }, + {}, + { + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, {}, @@ -71057,866 +69684,832 @@ var preCache = `{ "name": "jobstatus", "type": "integer" }, + { + "description": "the uuid of the physical network", + "name": "id", + "type": "string" + }, + { + "description": "comma separated tag", + "name": "tags", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the vlan of the physical network", + "name": "vlan", + "type": "string" }, - {} + { + "description": "state of the physical network", + "name": "state", + "type": "string" + } ], - "since": "4.11.0.0" + "since": "3.0.0" }, { - "description": "Add a supported Kubernetes version", + "description": "Lists autoscale vm groups.", "isasync": false, - "name": "addKubernetesSupportedVersion", + "name": "listAutoScaleVmGroups", "params": [ { - "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", + "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": "semanticversion", - "required": true, - "type": "string" + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "the minimum number of CPUs to be set with the Kubernetes version", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "mincpunumber", - "required": true, + "name": "projectid", + "related": "activateProject,createProject", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the availability zone ID", "length": 255, "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "checksum", + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "the name of the Kubernetes supported version", + "description": "the name of the autoscale vmgroup", "length": 255, "name": "name", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the minimum RAM size in MB to be set with the Kubernetes version", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "minmemory", - "required": true, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the ID of the policy", + "length": 255, + "name": "policyid", + "related": "listAutoScalePolicies", + "required": false, + "type": "uuid" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the loadbalancer", + "length": 255, + "name": "lbruleid", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the URL of the binaries ISO for Kubernetes supported version", + "description": "the ID of the autoscale vm group", "length": 255, - "name": "url", + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false", + "description": "the ID of the profile", "length": 255, - "name": "directdownload", + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", "required": false, - "since": "4.18.2", - "type": "boolean" + "type": "uuid" } ], - "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "related": "enableAutoScaleVmGroup", "response": [ { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "the project id of the vm group", + "name": "projectid", + "type": "string" }, { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the load balancer rule ID", + "name": "lbruleid", + "type": "string" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "description": "the account owning the vm group", + "name": "account", + "type": "string" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "the domain name of the vm group", + "name": "domain", + "type": "string" }, + {}, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", + "type": "string" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the date when this vm group was created", + "name": "created", + "type": "date" + }, + { + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" + }, + { + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "the private port", + "name": "privateport", "type": "string" }, - {}, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Deletes a Kubernetes cluster", - "isasync": true, - "name": "deleteKubernetesCluster", - "params": [ + }, { - "description": "Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false", - "length": 255, - "name": "expunge", - "required": false, - "since": "4.19.0", - "type": "boolean" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", - "length": 255, - "name": "cleanup", - "required": false, - "since": "4.19.0", - "type": "boolean" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the ID of the Kubernetes cluster", - "length": 255, + "description": "the autoscale vm group ID", "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - {}, + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the public ip address id", + "name": "publicipid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" } ] }, { - "description": "Creates a global load balancer rule", - "isasync": true, - "name": "createGlobalLoadBalancerRule", + "description": "Updates a Pod.", + "isasync": false, + "name": "updatePod", "params": [ { - "description": "load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", + "description": "the gateway for the Pod", "length": 255, - "name": "gslblbmethod", + "name": "gateway", "required": false, "type": "string" }, { - "description": "GSLB service type (tcp, udp, http)", + "description": "the starting IP address for the Pod", "length": 255, - "name": "gslbservicetype", - "required": true, - "type": "string" - }, - { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "name": "startip", "required": false, "type": "string" }, { - "description": "domain name for the GSLB service.", - "length": 255, - "name": "gslbdomainname", - "required": true, - "type": "string" - }, - { - "description": "region where the global load balancer is going to be created.", + "description": "the ID of the Pod", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "id", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "name of the load balancer rule", + "description": "the name of the Pod", "length": 255, "name": "name", - "required": true, + "required": false, "type": "string" }, { - "description": "the domain ID associated with the load balancer", + "description": "the ending IP address for the Pod", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "endip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "account", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "description": "the netmask of the Pod", "length": 255, - "name": "gslbstickysessionmethodname", + "name": "netmask", "required": false, "type": "string" } ], - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "related": "createPod,listPods,createManagementNetworkIpRange", "response": [ - {}, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "List of load balancer rules that are part of GSLB rule", - "name": "loadbalancerrule", + "description": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" + }, + {}, + { + "description": "the capacity of the Pod", + "name": "capacity", "response": [ { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the list of resource tags associated with load balancer", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the name of the load balancer", - "name": "name", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the public port", - "name": "publicport", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "the capacity name", + "name": "name", "type": "string" - }, + } + ], + "type": "list" + }, + {}, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" } ], "type": "list" }, + { + "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": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "name of the global load balancer rule", + "description": "the name of the Pod", "name": "name", "type": "string" }, { - "description": "the description of the global load balancer rule", - "name": "description", - "type": "string" - }, - { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "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 domain of the load balancer rule", - "name": "domain", + "description": "the ID of the Pod", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, - {}, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "global load balancer rule ID", - "name": "id", + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", - "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": "Link or unlink a userdata to a template.", - "isasync": false, - "name": "linkUserDataToTemplate", + "description": "Attaches an ISO to a virtual machine.", + "isasync": true, + "name": "attachIso", "params": [ { - "description": "the ID of the template for the virtual machine", + "description": "If true, ejects existing ISO before attaching on VMware. Default: false", "length": 255, - "name": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "forced", "required": false, - "type": "uuid" + "since": "4.15.1", + "type": "boolean" }, { - "description": "the ID of the ISO for the virtual machine", + "description": "the ID of the ISO file", "length": 255, - "name": "isoid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,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 userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO", + "description": "the ID of the virtual machine", "length": 255, - "name": "userdataid", - "related": "", - "required": false, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, "type": "uuid" - }, - { - "description": "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", - "length": 255, - "name": "userdatapolicy", - "required": false, - "type": "string" } ], - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "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 name of the OS type for this template.", - "name": "ostypename", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "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": "tag key name", - "name": "key", - "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": "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" - } - ], - "type": "set" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the project name of the template", - "name": "project", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "device type of the root volume", + "name": "rootdevicetype", + "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": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" }, - {}, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "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", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "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": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, + {}, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { @@ -71925,310 +70518,342 @@ var preCache = `{ "type": "integer" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, + {}, { - "description": "the template ID", - "name": "id", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" - } - ], - "since": "4.18.0" - }, - { - "description": " delete a netscaler load balancer device", - "isasync": true, - "name": "deleteNetscalerLoadBalancer", - "params": [ - { - "description": "netscaler load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", - "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" - } - ] - }, - { - "description": "Lists load balancer rules.", - "isasync": false, - "name": "listGlobalLoadBalancerRules", - "params": [ - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "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": "region ID", - "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", - "required": false, - "type": "integer" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" }, { - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the ID of the global load balancer rule", - "length": 255, - "name": "id", - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "updateGlobalLoadBalancerRule", - "response": [ - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the description of the global load balancer rule", - "name": "description", - "type": "string" - }, - { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the account of the load balancer rule", + "description": "the account associated with the virtual machine", "name": "account", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" - }, - { - "description": "GSLB service type", - "name": "gslbservicetype", - "type": "string" - }, - { - "description": "global load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "List of load balancer rules that are part of GSLB rule", - "name": "loadbalancerrule", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the public ip address", - "name": "publicip", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain of the load balancer rule", - "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "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" + } + ], + "type": "set" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the list of resource tags associated with load balancer", - "name": "tags", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "tag value", - "name": "value", + "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 project id the tag belongs to", - "name": "projectid", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, + { + "description": "the 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": "tag value", + "name": "value", + "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": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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": "set" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ { "description": "resource type", "name": "resourcetype", @@ -72244,11 +70869,26 @@ var preCache = `{ "name": "customer", "type": "string" }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", @@ -72258,903 +70898,1034 @@ var preCache = `{ "description": "the account associated with the tag", "name": "account", "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" } ], - "type": "list" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" + "type": "set" }, { - "description": "the state of the rule", - "name": "state", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the domain ID of the load balancer rule", + "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the name of the load balancer", - "name": "name", + "description": "the project id of the group", + "name": "projectid", "type": "string" } ], - "type": "list" + "type": "set" }, - {}, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, - {}, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", - "type": "string" - } - ] - }, - { - "description": "Updates a disk offering.", - "isasync": false, - "name": "deleteDiskOffering", - "params": [ - { - "description": "ID of the disk offering", - "length": 255, - "name": "id", - "related": "createDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} - ] - }, - { - "description": "List resource tag(s)", - "isasync": false, - "name": "listTags", - "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "list by resource type", - "length": 255, - "name": "resourcetype", - "required": false, + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list by key", - "length": 255, - "name": "key", - "required": false, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "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" - }, - { - "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": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list by value", - "length": 255, - "name": "value", - "required": false, - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, + {}, { - "description": "list by resource id", - "length": 255, - "name": "resourceid", - "required": false, - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "list by customer name", - "length": 255, - "name": "customer", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, - {}, - {}, { - "description": "tag key name", - "name": "key", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "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 project name where tag belongs to", - "name": "project", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "since": "4.0.0" - }, - { - "description": "Release the dedication for cluster", - "isasync": true, - "name": "releaseDedicatedCluster", - "params": [ - { - "description": "the ID of the Cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "Get Kubernetes cluster config", - "isasync": false, - "name": "getKubernetesClusterConfig", - "params": [ - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the id of the container cluster", - "name": "id", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + } + ], + "type": "set" }, - {}, { - "description": "the config data of the cluster", - "name": "configdata", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, - {}, - { - "description": "Name of the container cluster", - "name": "name", - "type": "string" - } - ] - }, - { - "description": "Create a virtual router element.", - "isasync": true, - "name": "createVirtualRouterElement", - "params": [ { - "description": "The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter", - "length": 255, - "name": "providertype", - "related": "listNetworkServiceProviders", - "required": false, - "type": "uuid" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the network service provider ID of the virtual router element", - "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders", - "required": true, - "type": "uuid" - } - ], - "related": "configureVirtualRouterElement,listVirtualRouterElements", - "response": [ - { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, - {}, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, - {}, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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 account associated with the provider", - "name": "account", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "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": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "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 ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" }, { - "description": "the id of the router", - "name": "id", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" } ] }, { - "description": "Creates a VPC", - "isasync": true, - "name": "createVPC", - "params": [ + "description": "(Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site.", + "isasync": false, + "name": "ldapRemove", + "params": [], + "related": "", + "response": [ { - "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", - "length": 255, - "name": "cidr", - "required": true, + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", "type": "string" }, { - "description": "VPC network domain. All networks inside the VPC will belong to this domain", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "DN password", + "name": "bindpass", "type": "string" }, { - "description": "the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the VPC", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account associated with the VPC. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "Specify the LDAP port if required, default is 389", + "name": "port", "type": "string" }, + {}, { - "description": "the first IPv4 DNS for the VPC", - "length": 255, - "name": "dns1", - "required": false, - "since": "4.18.0", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", + "name": "searchbase", "type": "string" }, + {}, { - "description": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", - "type": "integer" + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", + "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "length": 255, - "name": "ip6dns2", - "required": false, - "since": "4.18.0", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", + "type": "string" + } + ], + "since": "3.0.1" + }, + { + "description": "Creates a user for an account that already exists", + "isasync": false, + "name": "createUser", + "params": [ + { + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "dns2", + "name": "userid", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "IPV4 address to be assigned to the public interface of the network router.This address will be used as source NAT address for the networks in ths VPC. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", "length": 255, - "name": "sourcenatipaddress", - "required": false, - "since": "4.19", + "name": "password", + "required": true, "type": "string" }, { - "description": "create VPC for the project", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "timezone", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", + "description": "email", "length": 255, - "name": "ip6dns1", - "required": false, - "since": "4.18.0", + "name": "email", + "required": true, "type": "string" }, { - "description": "If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default.", + "description": "Unique username.", "length": 255, - "name": "start", - "required": false, - "since": "4.3", - "type": "boolean" + "name": "username", + "required": true, + "type": "string" }, { - "description": "the ID of the availability zone", + "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": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "account", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The display text of the VPC, defaults to its 'name'.", + "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", "length": 255, - "name": "displaytext", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "an optional field, whether to the display the vpc to the end user or not", + "description": "lastname", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "lastname", + "required": true, + "type": "string" }, { - "description": "the ID of the VPC offering", + "description": "firstname", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", + "name": "firstname", "required": true, - "type": "uuid" + "type": "string" } ], - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "related": "disableUser,getUser,listUsers,lockUser", "response": [ + {}, { - "description": "the id of the VPC", - "name": "id", + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "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" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "the list of resource tags associated with the project", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "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": "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 value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the VPC", - "name": "name", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user name", + "name": "username", "type": "string" }, + {}, { - "description": "the owner of the VPC", - "name": "account", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the user ID", + "name": "id", "type": "string" }, - {}, { - "description": "the project name of the VPC", - "name": "project", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + } + ] + }, + { + "description": "Add a custom action for an extension", + "isasync": false, + "name": "addCustomAction", + "params": [ + { + "description": "Name of the action", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "Success message that will be used on successful execution of the action. Name of the action, extension, resource can be used as - actionName, extensionName, resourceName. Example: Successfully complete {{actionName}} for {{resourceName}} with {{extensionName}}", + "length": 255, + "name": "successmessage", + "required": false, "type": "string" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", + "description": "Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 5 seconds", + "length": 255, + "name": "timeout", + "required": false, "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Description of the action", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "List of role types allowed for the action", + "length": 255, + "name": "allowedroletypes", + "required": false, + "type": "list" + }, + { + "description": "Whether the action is enabled or not. Default is disabled.", + "length": 255, + "name": "enabled", + "required": false, "type": "boolean" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "Resource type for which the action is available", + "length": 255, + "name": "resourcetype", + "required": false, "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", + "description": "Error message that will be used on failure during execution of the action. Name of the action, extension, resource can be used as - actionName, extensionName, resourceName. Example: Failed to complete {{actionName}} for {{resourceName}} with {{extensionName}}", + "length": 255, + "name": "errormessage", + "required": false, + "type": "string" + }, + { + "description": "The ID of the extension to associate the action with", + "length": 255, + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", + "required": true, + "type": "uuid" + }, + { + "description": "Parameters mapping for the action using keys - name, type, required. 'name' is mandatory. If 'type' is not specified then STRING will be used. If 'required' is not specified then false will be used. Example: parameters[0].name=xxx¶meters[0].type=BOOLEAN¶meters[0].required=true", + "length": 255, + "name": "parameters", + "required": false, + "type": "map" + } + ], + "related": "listCustomActions", + "response": [ + { + "description": "Message that will be used on failure during execution of the action", + "name": "errormessage", + "type": "string" + }, + { + "description": "Resource type for which the action is available", + "name": "resourcetype", + "type": "string" + }, + { + "description": "Whether the custom action is enabled or not", + "name": "enabled", "type": "boolean" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "List of role types allowed for the custom action", + "name": "allowedroletypes", + "type": "list" + }, + { + "description": "Details of the custom action", + "name": "details", + "type": "map" + }, + { + "description": "Description of the custom action", + "name": "description", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "Name of the extension that this custom action belongs to", + "name": "extensionname", "type": "string" }, - {}, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "Message that will be used on successful execution of the action", + "name": "successmessage", + "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "Name of the custom action", + "name": "name", + "type": "string" + }, + { + "description": "List of the parameters for the action", + "name": "parameters", + "response": [ + { + "description": "Type of the parameter", + "name": "type", + "type": "string" + }, + { + "description": "Validation format for value of the parameter. Available for specific types", + "name": "validationformat", + "type": "string" + }, + { + "description": "Name of the parameter", + "name": "name", + "type": "string" + }, + { + "description": "Comma-separated list of options for value of the parameter", + "name": "valueoptions", + "type": "list" + }, + { + "description": "Whether the parameter is required or not", + "name": "required", + "type": "boolean" + } + ], + "type": "list" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" + "description": "Specifies the timeout in seconds to wait for the action to complete before failing", + "name": "timeout", + "type": "integer" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "ID of the custom action", + "name": "id", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "Creation timestamp of the custom action", + "name": "created", + "type": "date" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "ID of the extension that this custom action belongs to", + "name": "extensionid", "type": "string" } - ] + ], + "since": "4.21.0" }, { - "description": "Deletes a autoscale policy.", + "description": "Creates site to site vpn local gateway", "isasync": true, - "name": "deleteAutoScalePolicy", + "name": "createVpnGateway", "params": [ { - "description": "the ID of the autoscale policy", + "description": "id of the vpc", "length": 255, - "name": "id", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": true, "type": "uuid" + }, + { + "description": "the public IP address ID for which VPN gateway is being enabled. By default the source NAT IP or router IP will be used.", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "an optional field, whether to the display the vpn to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], + "related": "updateVpnGateway", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { @@ -73162,75 +71933,113 @@ var preCache = `{ "name": "jobid", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the vpc id of this gateway", + "name": "vpcid", + "type": "string" }, - {} - ] - }, - { - "description": "Deletes a role", - "isasync": false, - "name": "deleteRole", - "params": [ { - "description": "ID of the role", - "length": 255, - "name": "id", - "related": "createRole,importRole,listRoles,updateRole", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "the domain path of the owner", + "name": "domainpath", + "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 domain id of the owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the vpc name of this gateway", + "name": "vpcname", + "type": "string" + }, + { + "description": "the public IP address", + "name": "publicip", + "type": "string" + }, + { + "description": "the project name", + "name": "project", + "type": "string" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the owner", + "name": "account", "type": "string" - } - ], - "since": "4.9.0" + }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + {} + ] }, { - "description": " delete a Cisco Nexus VSM device", + "description": "Adds detail for the Resource.", "isasync": true, - "name": "deleteCiscoNexusVSM", + "name": "addResourceDetail", "params": [ { - "description": "Id of the Cisco Nexus 1000v VSM device to be deleted", + "description": "pass false if you want this detail to be disabled for the regular user. True by default", "length": 255, - "name": "id", - "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "resource id to create the details for", + "length": 255, + "name": "resourceid", "required": true, - "type": "uuid" + "type": "string" + }, + { + "description": "type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" + }, + { + "description": "Map of (key/value pairs)", + "length": 255, + "name": "details", + "required": true, + "type": "map" } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -73241,47 +72050,24 @@ var preCache = `{ "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": "List internal LB VMs.", + "description": "Lists vpn users", "isasync": false, - "name": "listInternalLoadBalancerVMs", + "name": "listVpnUsers", "params": [ { - "description": "list by network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "", @@ -73291,72 +72077,36 @@ var preCache = `{ "type": "integer" }, { - "description": "the name of the Internal LB VM", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the state of the Internal LB VM", - "length": 255, - "name": "state", - "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": "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 ID of the Internal LB VM", + "description": "The uuid of the Vpn user", "length": 255, "name": "id", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "addVpnUser,listVpnUsers", "required": false, "type": "uuid" }, { - "description": "the host ID of the Internal LB VM", + "description": "the username of the vpn user.", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "username", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Pod ID of the Internal LB VM", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "projectid", + "related": "activateProject,createProject", "required": false, "type": "uuid" }, { - "description": "List Internal LB VMs by VPC", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, - { - "description": "if true is passed for this parameter, list only VPC Internal LB VMs", - "length": 255, - "name": "forvpc", - "required": false, - "type": "boolean" - }, { "description": "List by keyword", "length": 255, @@ -73365,48 +72115,43 @@ var preCache = `{ "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the Zone ID of the Internal LB VM", + "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": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "fetchhealthcheckresults", + "name": "isrecursive", "required": false, - "since": "4.14", "type": "boolean" } ], - "related": "destroyRouter,listRouters", + "related": "addVpnUser", "response": [ { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the domain name of the account of the remote access vpn", + "name": "domain", + "type": "string" + }, + { + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -73414,1923 +72159,1850 @@ var preCache = `{ "type": "integer" }, { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", + "description": "the vpn userID", + "name": "id", "type": "string" }, + {}, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the project id of the ipaddress", + "description": "the project id of the vpn", "name": "projectid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", + "name": "state", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the username of the vpn user", + "name": "username", "type": "string" - }, + } + ] + }, + { + "description": "Deletes an IP forwarding rule", + "isasync": true, + "name": "deleteIpForwardingRule", + "params": [ { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, + "description": "the ID of the forwarding rule", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "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": "Register a new User Data.", + "isasync": false, + "name": "registerUserData", + "params": [ + { + "description": "Name of the user data", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "User data content", + "length": 1048576, + "name": "userdata", + "required": true, + "type": "string" + }, + { + "description": "an optional project for the user data", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the user data. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "an optional domainId for the user data. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "comma separated list of variables declared in user data content", + "length": 255, + "name": "params", + "required": false, "type": "string" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "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 name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ], + "since": "4.18" + }, + { + "description": "Adds a Region", + "isasync": false, + "name": "addRegion", + "params": [ { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "Region service endpoint", + "length": 255, + "name": "endpoint", + "required": true, "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "Id of the Region", + "length": 255, + "name": "id", + "required": true, + "type": "integer" + }, + { + "description": "Name of the region", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "updateRegion", + "response": [ + { + "description": "the end point of the region", + "name": "endpoint", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the ID of the region", + "name": "id", + "type": "integer" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" + }, + { + "description": "the name of the region", + "name": "name", "type": "string" }, { - "description": "the domain ID associated with the router", + "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 security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" + } + ] + }, + { + "description": "Generates usage records. This will generate records only if there any records to be generated, i.e if the scheduled usage job was not run or failed", + "isasync": false, + "name": "generateUsageRecords", + "params": [ + { + "description": "List events for the specified domain.", + "length": 255, "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" + }, + { + "description": "Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + } + ], + "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 second DNS for the router", - "name": "dns2", + "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": "Updates a role permission order", + "isasync": false, + "name": "updateRolePermission", + "params": [ + { + "description": "ID of the role", + "length": 255, + "name": "roleid", + "related": "createRole,listRoles,updateRole", + "required": true, + "type": "uuid" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "Rule permission, can be: allow or deny", + "length": 255, + "name": "permission", + "required": false, + "since": "4.11", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "length": 255, + "name": "ruleorder", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "Role permission rule id", + "length": 255, + "name": "ruleid", + "related": "", + "required": false, + "since": "4.11", + "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": "role of the domain router", - "name": "role", + "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" + } + ], + "since": "4.9.0" + }, + { + "description": "Lists accounts and provides detailed account information for listed accounts", + "isasync": false, + "name": "listAccounts", + "params": [ + { + "description": "list accounts by cleanuprequired attribute (values are true or false)", + "length": 255, + "name": "iscleanuprequired", + "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": "List accounts by the Api key access value", + "length": 255, + "name": "apikeyaccess", + "required": false, + "since": "4.20.1.0", "type": "string" }, { - "description": "the name of the router", + "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": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", + "length": 255, + "name": "accounttype", + "required": false, + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "list account by account name", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "list accounts by state. Valid states are enabled, disabled, and locked.", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", + "length": 255, + "name": "details", + "required": false, + "type": "list" + }, + { + "description": "Tag for resource type to return usage", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "flag to display the resource icon for accounts", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "list account by account ID", + "length": 255, + "name": "id", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + } + ], + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "response": [ + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - } - ], - "type": "list" + "description": "the total number of backups available to this account", + "name": "backupavailable", + "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the type of the nic", - "name": "type", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the user lastname", + "name": "lastname", "type": "string" } ], - "type": "set" - } - ] - }, - { - "description": "Lists Cisco VNMC controllers", - "isasync": false, - "name": "listCiscoVnmcResources", - "params": [ + "type": "list" + }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "Cisco VNMC resource ID", - "length": 255, - "name": "resourceid", - "related": "listCiscoVnmcResources", - "required": false, - "type": "uuid" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" }, - {}, - {}, - {}, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} - ] - }, - { - "description": "Execute DRS for a cluster. If there is another plan in progress for the same cluster, this command will fail.", - "isasync": true, - "name": "executeClusterDrsPlan", - "params": [ { - "description": "Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=&migrateto[vm-index].host= Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm= indicates the UUID of the vm that you want to migrate, and host= indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", - "length": 255, - "name": "migrateto", - "required": false, - "type": "map" + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", + "type": "string" }, { - "description": "ID of cluster", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "List of migrations", - "name": "migrations", - "type": "list" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "unique ID of the drs plan for cluster", - "name": "id", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, - {}, { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "Id of the cluster", - "name": "clusterid", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, - {}, { - "description": "Start event Id of the DRS Plan", - "name": "eventid", - "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Removes detail for the Resource.", - "isasync": true, - "name": "removeResourceDetail", - "params": [ + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, { - "description": "Delete details for resource id", - "length": 255, - "name": "resourceid", - "required": true, + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "Delete detail by resource type", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Delete details matching key/value pairs", - "length": 255, - "name": "key", - "required": false, + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" - } - ], - "response": [ + }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if account is default, false otherwise", + "name": "isdefault", "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists all supported OS types for this cloud.", - "isasync": false, - "name": "listOsTypes", - "params": [ + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", + "type": "string" }, + {}, { - "description": "list by Os Category id", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": false, - "type": "uuid" + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "list by Os type Id", - "length": 255, - "name": "id", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "description": "list os by description", - "length": 255, - "name": "description", - "required": false, - "since": "3.0.1", + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.18.1", - "type": "boolean" - } - ], - "related": "addGuestOs", - "response": [ + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, - {}, { - "description": "the ID of the OS type", - "name": "id", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the ID of the OS category", - "name": "oscategoryid", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the name/description of the OS type", - "name": "description", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the name of the OS category", - "name": "oscategoryname", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the name of the OS type", - "name": "name", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "is the guest OS visible for the users", - "name": "fordisplay", - "type": "boolean" + "description": "the name of the account", + "name": "name", + "type": "string" } ] }, { - "description": "Deletes a particular egress rule from this security group", + "description": "Destroys a router.", "isasync": true, - "name": "revokeSecurityGroupEgress", + "name": "destroyRouter", "params": [ { - "description": "The ID of the egress rule", + "description": "the ID of the router", "length": 255, "name": "id", - "related": "authorizeSecurityGroupIngress", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "required": true, "type": "uuid" } ], + "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "Removes a Guest OS from listing.", - "isasync": true, - "name": "removeGuestOs", - "params": [ { - "description": "ID of the guest OS", - "length": 255, - "name": "id", - "related": "addGuestOs", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, { - "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.4.0" - }, - { - "description": "Uploads an icon for the specified resource(s)", - "isasync": false, - "name": "uploadResourceIcon", - "params": [ - { - "description": "list of resources to upload the icon/image for", - "length": 255, - "name": "resourceids", - "required": true, - "type": "list" - }, - { - "description": "Base64 string representation of the resource icon/image", - "length": 2097152, - "name": "base64image", - "required": true, - "type": "string" - }, - { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" - } - ], - "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} - ], - "since": "4.16.0.0" - }, - { - "description": "Update a supported Kubernetes version", - "isasync": false, - "name": "updateKubernetesSupportedVersion", - "params": [ - { - "description": "the enabled or disabled state of the Kubernetes supported version", - "length": 255, - "name": "state", - "required": true, + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the ID of the Kubernetes supported version", - "length": 255, - "name": "id", - "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", - "required": true, - "type": "uuid" - } - ], - "related": "listKubernetesSupportedVersions", - "response": [ - { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the project name of the address", + "name": "project", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" - }, - { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" - }, - { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" - }, - { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {} - ] - }, - { - "description": "Detaches any ISO file (if any) currently attached to a virtual machine.", - "isasync": true, - "name": "detachIso", - "params": [ { - "description": "If true, ejects the ISO before detaching on VMware. Default: false", - "length": 255, - "name": "forced", - "required": false, - "since": "4.15.1", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the account associated with the virtual machine", + "description": "the account associated with the router", "name": "account", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "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", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the public IP address for the router", + "name": "publicip", "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": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "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": "customer associated with the tag", - "name": "customer", - "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "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": "set" - } - ], - "type": "set" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" - } - ], - "type": "set" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ + }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" } ], "type": "set" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, + {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + } + ], + "type": "list" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, + {}, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the router", + "name": "name", "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", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + } + ] + }, + { + "description": "Lists image stores.", + "isasync": false, + "name": "listImageStores", + "params": [ + { + "description": "the image store protocol", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "read-only status of the image store", + "length": 255, + "name": "readonly", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", + "required": false, + "since": "4.15.0", + "type": "boolean" }, - {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "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": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, - {}, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the image store provider", + "length": 255, + "name": "provider", + "required": false, + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the name of the image store", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "the ID of the storage pool", + "length": 255, "name": "id", - "type": "string" + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", + "required": false, + "type": "uuid" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the Zone ID for the image store", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" + } + ], + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore", + "response": [ + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, + {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - } - ], - "type": "set" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, + {} + ], + "since": "4.2.0" + }, + { + "description": "Deletes a account, and all users associated with this account", + "isasync": true, + "name": "deleteAccount", + "params": [ { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "Account id", + "length": 255, + "name": "id", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "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" + }, + {} + ] + }, + { + "description": "Disables out-of-band management for a cluster", + "isasync": true, + "name": "disableOutOfBandManagementForCluster", + "params": [ + { + "description": "the ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost,configureOutOfBandManagement,changeOutOfBandManagementPassword", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the list of resource tags associated", + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" + }, + {}, + { + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" + }, + { + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" + }, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" + }, + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the operation result description", + "name": "description", + "type": "string" + }, + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + { + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" + }, + {}, + { + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "Activates a project", + "isasync": true, + "name": "activateProject", + "params": [ + { + "description": "id of the project to be modified", + "length": 255, + "name": "id", + "related": "activateProject,createProject", + "required": true, + "type": "uuid" + } + ], + "related": "createProject", + "response": [ + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", + "type": "string" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of buckets available to this project", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the id of the project", + "name": "id", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -75339,167 +74011,192 @@ var preCache = `{ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" - } - ] - }, - { - "description": "Creates a guest network IPv6 prefix.", - "isasync": true, - "name": "createGuestNetworkIpv6Prefix", - "params": [ + }, { - "description": "UUID of zone to which the IPv6 prefix belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", + "type": "string" }, { - "description": "The /56 or higher IPv6 CIDR for network prefix.", - "length": 255, - "name": "prefix", - "required": true, + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" - } - ], - "related": "listGuestNetworkIpv6Prefixes", - "response": [ + }, { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", - "type": "integer" + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" }, { - "description": "id of the guest IPv6 prefix", - "name": "id", + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", - "type": "integer" + "description": "the state of the project", + "name": "state", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -75507,185 +74204,210 @@ var preCache = `{ "type": "integer" }, { - "description": "guest IPv6 prefix", - "name": "prefix", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", - "type": "integer" + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" }, { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, - {} - ], - "since": "4.17.0.0" - }, - { - "description": " delete a Palo Alto firewall device", - "isasync": true, - "name": "deletePaloAltoFirewall", - "params": [ { - "description": "Palo Alto firewall device ID", - "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the total number of backups available to this project", + "name": "backupavailable", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", + "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the project", + "name": "name", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "Deletes a Pod.", + "description": "Delete a certificate to CloudStack", "isasync": false, - "name": "deletePod", + "name": "deleteSslCert", "params": [ { - "description": "the ID of the Pod", + "description": "Id of SSL certificate", "length": 255, "name": "id", - "related": "updatePod,createManagementNetworkIpRange", + "related": "uploadSslCert", "required": true, "type": "uuid" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Lists Tungsten-Fabric providers", + "description": "Prepares management server for maintenance by preventing new jobs from being accepted after completion of active jobs and migrating the agents", "isasync": false, - "name": "listTungstenFabricProviders", + "name": "prepareForMaintenance", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "indirect agents load balancer algorithm (static, roundrobin, shuffle); when this is not set, already configured algorithm from setting 'indirect.agent.lb.algorithm' is considered", "length": 255, - "name": "keyword", + "name": "algorithm", "required": false, "type": "string" }, { - "description": "", + "description": "Force management server to maintenance after the maintenance window timeout, default is false", "length": 255, - "name": "page", + "name": "forced", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "", + "description": "the id of the management server", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "managementserverid", + "related": "listManagementServers", + "required": true, "type": "uuid" } ], - "related": "", + "related": "prepareForShutdown,cancelShutdown,readyForShutdown", "response": [ { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric provider name", - "name": "name", - "type": "string" + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" }, - {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "The id of the management server", + "name": "managementserverid", "type": "string" }, { - "description": "Tungsten-Fabric provider vrouter port", - "name": "tungstenprovidervrouterport", - "type": "string" + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" }, { - "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": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", - "type": "string" + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" }, { - "description": "Tungsten-Fabric provider hostname", - "name": "tungstenproviderhostname", - "type": "string" + "description": "the state of the management server", + "name": "state", + "type": "state" }, + {}, + {}, { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", - "type": "string" + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -75693,62 +74415,64 @@ var preCache = `{ "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", "type": "boolean" - }, - { - "description": "Tungsten-Fabric provider port", - "name": "tungstenproviderport", - "type": "string" - }, - {}, - { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", - "type": "string" } - ] + ], + "since": "4.21.0" }, { - "description": "Lists all DeploymentPlanners available.", + "description": "Delete one or more alerts.", "isasync": false, - "name": "listDeploymentPlanners", + "name": "deleteAlerts", "params": [ { - "description": "", + "description": "start date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "pagesize", + "name": "startdate", "required": false, - "type": "integer" + "type": "date" }, { - "description": "List by keyword", + "description": "the IDs of the alerts", "length": 255, - "name": "keyword", + "name": "ids", + "related": "listAlerts,listAlertTypes", "required": false, - "type": "string" + "type": "list" }, { - "description": "", + "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "page", + "name": "enddate", "required": false, - "type": "integer" + "type": "date" + }, + { + "description": "delete by alert type", + "length": 255, + "name": "type", + "required": false, + "type": "string" } ], - "related": "", "response": [ - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "Deployment Planner name", - "name": "name", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -75759,835 +74483,801 @@ var preCache = `{ ] }, { - "description": "Deletes a cluster.", - "isasync": false, - "name": "deleteCluster", + "description": "Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature.", + "isasync": true, + "name": "createAutoScaleVmProfile", "params": [ { - "description": "the cluster ID", + "description": "the ID of the user used to launch and destroy the VMs", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, + "name": "autoscaleuserid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": false, "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 template of the auto deployed virtual machine", + "length": 255, + "name": "templateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the time allowed for existing connections to get closed before a vm is expunged", + "length": 255, + "name": "expungevmgraceperiod", + "required": false, "type": "integer" - } - ] - }, - { - "description": "Prepares a host for maintenance.", - "isasync": true, - "name": "prepareHostForMaintenance", - "params": [ + }, { - "description": "the host ID", + "description": "the service offering of the auto deployed virtual machine", "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" - } - ], - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", - "response": [ + }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "length": 255, + "name": "counterparam", + "required": false, + "type": "map" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "the ID of the Userdata", + "length": 255, + "name": "userdataid", + "related": "listCniConfiguration", + "required": false, + "since": "4.18.1", + "type": "uuid" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "an optional project for the autoscale VM profile", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "the Zone ID of the host", + "description": "availability zone for the auto deployed virtual machine", + "length": 255, "name": "zoneid", - "type": "string" + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine.\nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "length": 255, + "name": "otherdeployparams", + "required": false, + "type": "map" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "an optional field, whether to the display the profile to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "domain ID of the account owning a autoscale VM profile", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "account that will own the autoscale VM profile", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18.1", + "type": "map" + } + ], + "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "response": [ + { + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "is profile for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" + }, + { + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, + {}, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", "type": "integer" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the project id vm profile", + "name": "projectid", + "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, - {}, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the domain ID of the vm profile", + "name": "domainid", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", + "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, + {}, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the autoscale vm profile ID", + "name": "id", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, + {}, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the availability zone to be used while deploying a virtual machine", + "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 currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, + {} + ] + }, + { + "description": "Register the OAuth2 provider in CloudStack", + "isasync": false, + "name": "registerOauthProvider", + "params": [ { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" - }, - {}, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "events available for the host", - "name": "events", + "description": "Name of the provider from the list of OAuth providers supported in CloudStack", + "length": 255, + "name": "provider", + "required": true, "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "Secret Key pre-registered in the specific OAuth provider", + "length": 255, + "name": "secretkey", + "required": true, "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "Redirect URI pre-registered in the specific OAuth provider", + "length": 255, + "name": "redirecturi", + "required": true, + "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "Description of the OAuth Provider", + "length": 255, + "name": "description", + "required": true, + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, + "description": "Client ID pre-registered in the specific OAuth provider", + "length": 255, + "name": "clientid", + "required": true, + "type": "string" + } + ], + "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ], + "since": "4.19.0" + }, + { + "description": "Lists load balancer stickiness policies.", + "isasync": false, + "name": "listLBStickinessPolicies", + "params": [ { - "description": "capabilities of the host", - "name": "capabilities", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the ID of the load balancer stickiness policy", + "length": 255, + "name": "id", + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", + "required": false, + "type": "uuid" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "required": false, + "type": "uuid" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + } + ], + "related": "createLBStickinessPolicy,updateLBStickinessPolicy", + "response": [ { - "description": "the Pod name of the host", - "name": "podname", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the account of the Stickiness policy", + "name": "account", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "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 memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the state of the policy", + "name": "state", + "type": "string" }, + {}, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the domain of the Stickiness policy", + "name": "domain", + "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the domain ID of the Stickiness policy", + "name": "domainid", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", + "response": [ + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, + { + "description": "the LB Stickiness policy ID", + "name": "id", + "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + }, + { + "description": "the method name of the Stickiness policy", + "name": "methodname", + "type": "string" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the params of the policy", + "name": "params", + "type": "map" + } + ], + "type": "list" } - ] + ], + "since": "3.0.0" }, { - "description": "Creates a role", + "description": "Updates an existing GPU device", "isasync": false, - "name": "createRole", + "name": "updateGpuDevice", "params": [ { - "description": "Creates a role with this unique name", + "description": "New type of GPU device (PCI, MDEV, VGPUOnly)", "length": 255, - "name": "name", - "required": true, + "name": "type", + "required": false, "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", + "description": "New NUMA node of the GPU device", "length": 255, - "name": "ispublic", + "name": "numanode", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "New parent GPU device ID (for virtual GPU devices)", "length": 255, - "name": "type", + "name": "parentgpudeviceid", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The description of the role", + "description": "New vGPU profile ID", "length": 255, - "name": "description", + "name": "vgpuprofileid", + "related": "createVgpuProfile,updateVgpuProfile", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "ID of the role to be cloned from. Either roleid or type must be passed in", + "description": "New GPU card ID", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "gpucardid", + "related": "listGpuCards", "required": false, "type": "uuid" + }, + { + "description": "ID of the GPU device to update", + "length": 255, + "name": "id", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", + "required": true, + "type": "uuid" } ], - "related": "importRole,listRoles,updateRole", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", + "type": "string" }, { - "description": "the ID of the role", + "description": "the ID of the GPU device", "name": "id", "type": "string" }, - {}, - {}, - { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the type of the role", - "name": "type", + "description": "the host name where the GPU device is attached", + "name": "hostname", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the vGPU profile name assigned to this GPU device", + "name": "virtualmachinename", "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "the NUMA node where the GPU device is located", + "name": "numanode", "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "Removes specified region", - "isasync": false, - "name": "removeRegion", - "params": [ + }, { - "description": "ID of the region to delete", - "length": 255, - "name": "id", - "required": true, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Get Volume's iSCSI Name", - "isasync": false, - "name": "getVolumeiScsiName", - "params": [ + "description": "the vGPU profile name assigned to this GPU device", + "name": "state", + "type": "state" + }, { - "description": "CloudStack Volume UUID", - "length": 255, - "name": "volumeid", - "required": true, + "description": "the host ID where the GPU device is attached", + "name": "hostid", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "Volume iSCSI Name", - "name": "volumeiScsiName", + "description": "the GPU card name associated with this GPU device", + "name": "gpucardname", "type": "string" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Upload a data disk to the cloudstack cloud.", - "isasync": false, - "name": "getUploadParamsForVolume", - "params": [ - { - "description": "Upload volume/template/iso for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the managed state of the GPU device (Enabled/Disabled)", + "name": "managedstate", + "type": "managedstate" }, { - "description": "Image store uuid", - "length": 255, - "name": "imagestoreuuid", - "required": false, + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the state of the virtual machine to which this GPU device is allocated", + "name": "vmstate", + "type": "state" }, { - "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": false, - "type": "uuid" - }, + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", + "type": "string" + } + ], + "since": "4.21.0" + }, + { + "description": "Adds a Ucs manager", + "isasync": false, + "name": "addUcsManager", + "params": [ { - "description": "the name of the volume/template/iso", + "description": "the name of UCS url", "length": 255, - "name": "name", + "name": "url", "required": true, "type": "string" }, { - "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "the name of UCS manager", "length": 255, - "name": "checksum", + "name": "name", "required": false, "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "the Zone id for the ucs manager", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "the password of UCS", "length": 255, - "name": "format", + "name": "password", "required": true, "type": "string" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "the username of UCS", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "username", "required": true, - "type": "uuid" + "type": "string" } ], - "related": "getUploadParamsForTemplate,getUploadParamsForIso", + "related": "listUcsManagers", "response": [ { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "the zone ID of ucs manager", + "name": "zoneid", "type": "string" }, + {}, { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" + "description": "the name of ucs manager", + "name": "name", + "type": "string" }, { - "description": "the template/volume ID", + "description": "the ID of the ucs manager", "name": "id", - "type": "uuid" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the url of ucs manager", + "name": "url", "type": "string" }, {} - ], - "since": "4.6.0" + ] }, { - "description": "Updates an existing autoscale vm group.", + "description": "Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected.", "isasync": true, - "name": "updateAutoScaleVmGroup", + "name": "deleteVnfTemplate", "params": [ { - "description": "the ID of the autoscale group", + "description": "the ID of zone of the template", "length": 255, - "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "required": true, + "name": "zoneid", + "related": "listZones", + "required": false, "type": "uuid" }, { - "description": "the name of the autoscale vmgroup", + "description": "Force delete a template.", "length": 255, - "name": "name", + "name": "forced", "required": false, - "since": "4.18.0", - "type": "string" + "since": "4.9+", + "type": "boolean" }, { - "description": "list of scaledown autoscale policies", + "description": "the ID of the template", "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": false, - "type": "list" + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "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", + "description": "Necessary if the template's type is system.", "length": 255, - "name": "customid", + "name": "issystem", "required": false, - "since": "4.4", + "since": "4.20.0", + "type": "boolean" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "an optional field, whether to the display the group to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "the frequency in which the performance counters to be collected", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ], + "since": "4.19.0" + }, + { + "description": "lists netscaler load balancer devices", + "isasync": false, + "name": "listNetscalerLoadBalancers", + "params": [ + { + "description": "netscaler load balancer device ID", "length": 255, - "name": "interval", + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "description": "", "length": 255, - "name": "maxmembers", + "name": "page", "required": false, "type": "integer" }, { - "description": "list of scaleup autoscale policies", + "description": "List by keyword", "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "keyword", "required": false, - "type": "list" + "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "description": "", "length": 255, - "name": "minmembers", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" } ], - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" - }, - { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" - }, - { - "description": "the project name of the vm group", - "name": "project", - "type": "string" - }, - { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" - }, - { - "description": "the domain ID of the vm group", - "name": "domainid", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - {}, - { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { @@ -76596,1200 +75286,1273 @@ var preCache = `{ "type": "integer" }, { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "the account owning the vm group", - "name": "account", - "type": "string" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", "type": "list" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "name of the provider", + "name": "provider", + "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", - "type": "string" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "is group for display to the regular user", - "name": "fordisplay", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", "type": "boolean" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, + {}, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" } ] }, { - "description": "Updates an existing autoscale vm profile.", - "isasync": true, - "name": "updateAutoScaleVmProfile", + "description": "Creates a vm group", + "isasync": false, + "name": "createInstanceGroup", "params": [ { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", - "length": 255, - "name": "counterparam", - "required": false, - "type": "map" - }, - { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", - "length": 255, - "name": "otherdeployparams", - "required": false, - "since": "4.18.0", - "type": "map" - }, - { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "the domain ID of account owning the instance group", "length": 255, - "name": "autoscaleuserid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "an optional field, whether to the display the profile to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, - "since": "4.18.0", - "type": "string" - }, - { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "length": 255, - "name": "expungevmgraceperiod", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the autoscale vm profile", + "description": "the name of the instance group", "length": 255, - "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "name": "name", "required": true, - "type": "uuid" - }, - { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18.1", - "type": "map" - }, - { - "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": "the template of the auto deployed virtual machine", - "length": 255, - "name": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "type": "uuid" - }, - { - "description": "the service offering of the auto deployed virtual machine", + "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "account", "required": false, - "since": "4.18.0", - "type": "uuid" + "type": "string" }, { - "description": "the ID of the userdata", + "description": "The project of the instance group", "length": 255, - "name": "userdataid", - "related": "", + "name": "projectid", + "related": "createProject", "required": false, - "since": "4.18.1", "type": "uuid" } ], - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", + "related": "updateInstanceGroup", "response": [ + {}, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, { - "description": "is profile for display to the regular user", - "name": "fordisplay", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, { - "description": "the domain name of the vm profile", + "description": "the domain name of the instance group", "name": "domain", "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", - "type": "string" - }, - { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the vm profile", + "description": "the project name of the instance group", "name": "project", "type": "string" }, - { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" - }, - {}, - { - "description": "the domain ID of the vm profile", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the instance group", - "name": "account", - "type": "string" - }, {}, { - "description": "the project id vm profile", - "name": "projectid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the instance group", + "name": "id", "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", - "type": "string" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" }, - {}, { - "description": "Base 64 encoded VM user data", - "name": "userdata", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" } ] }, { - "description": "Enables an AutoScale Vm Group", + "description": "Creates an internal load balancer", "isasync": true, - "name": "enableAutoScaleVmGroup", + "name": "createLoadBalancer", "params": [ { - "description": "the ID of the autoscale group", + "description": "the network id of the source ip address", "length": 255, - "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "name": "sourceipaddressnetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": true, "type": "uuid" - } - ], - "related": "listAutoScaleVmGroups", - "response": [ + }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the source port the network traffic will be load balanced from", + "length": 255, + "name": "sourceport", + "required": true, + "type": "integer" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "the description of the load balancer", + "length": 4096, + "name": "description", + "required": false, + "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the source IP address the network traffic will be load balanced from", + "length": 255, + "name": "sourceipaddress", + "required": false, "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, + "name": "algorithm", + "required": true, "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", + "description": "the load balancer scheme. Supported value in this release is Internal", + "length": 255, + "name": "scheme", + "required": true, + "type": "string" + }, + { + "description": "The guest network the load balancer will be created for", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", + "length": 255, + "name": "instanceport", + "required": true, + "type": "integer" + }, + { + "description": "name of the load balancer", + "length": 255, + "name": "name", + "required": true, + "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": "", + "response": [ + { + "description": "the account of the Load Balancer", + "name": "account", + "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, { - "description": "the domain ID of the vm group", + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "the name of the instance", + "name": "name", + "type": "string" + }, + { + "description": "the ip address of the instance", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the instance ID", + "name": "id", + "type": "string" + }, + { + "description": "the state of the instance", + "name": "state", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of resource tags associated with the Load Balancer", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + {}, + { + "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 load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" + }, + { + "description": "the project name of the Load Balancer", + "name": "project", + "type": "string" + }, + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "description": "the domain ID of the Load Balancer", "name": "domainid", "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the domain of the Load Balancer", + "name": "domain", + "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", + "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + }, + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + } + ], + "type": "list" + }, + {} + ], + "since": "4.2.0" + }, + { + "description": "Updates a user-defined VM backup schedule", + "isasync": false, + "name": "updateBackupSchedule", + "params": [ + { + "description": "custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28)", + "length": 255, + "name": "schedule", + "required": true, "type": "string" }, - {}, { - "description": "the private port", - "name": "privateport", + "description": "ID of the VM for which schedule is to be defined", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "length": 255, + "name": "timezone", + "required": true, "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "length": 255, + "name": "intervaltype", + "required": true, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS backup provider. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.", + "length": 255, + "name": "quiescevm", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "The maximum number of backups to keep for a VM. If \"0\", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.", + "length": 255, + "name": "maxbackups", + "required": false, + "since": "4.21.0", "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "name of the VM", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { - "description": "the public ip address id", - "name": "publicipid", + "description": "domain name", + "name": "domain", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "backup offering name", + "name": "backupofferingname", "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "Interval type of the backup", + "name": "intervaltype", "type": "string" }, { - "description": "the autoscale vm group ID", + "description": "ID of the VM backup", "name": "id", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "zone id", + "name": "zoneid", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "account name", + "name": "account", "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "backed up volumes", + "name": "volumes", + "type": "string" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "external backup id", + "name": "externalid", + "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "ID of the VM", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "backup type", + "name": "type", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "description for the backup", + "name": "description", + "type": "string" + }, + { + "description": "backup date", + "name": "created", + "type": "date" + }, + { + "description": "backup status", + "name": "status", + "type": "status" + }, + { + "description": "name of the backup", + "name": "name", + "type": "string" + }, + { + "description": "The backup offering corresponding to this backup was removed from the VM", + "name": "vmbackupofferingremoved", "type": "boolean" + }, + { + "description": "backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" + }, + { + "description": "account id", + "name": "accountid", + "type": "string" + }, + { + "description": "zone name", + "name": "zone", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Lists the vm specific details for the backup", + "name": "vmdetails", + "type": "map" + }, + { + "description": "backup size in bytes", + "name": "size", + "type": "long" + }, + {}, + { + "description": "backup offering id", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "domain id", + "name": "domainid", + "type": "string" } - ] + ], + "since": "4.14.0" }, { - "description": "Deletes a snapshot of a disk volume.", + "description": "Adds a Palo Alto firewall device", "isasync": true, - "name": "deleteSnapshot", + "name": "addPaloAltoFirewall", "params": [ { - "description": "The ID of the zone for the snapshot", + "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.19.0", - "type": "uuid" + "name": "username", + "required": true, + "type": "string" }, { - "description": "The ID of the snapshot", + "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "id", - "related": "copySnapshot,revertSnapshot,listSnapshots", + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "URL of the Palo Alto appliance.", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "supports only PaloAltoFirewall", + "length": 255, + "name": "networkdevicetype", + "required": true, + "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": true, "type": "uuid" } ], + "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", "response": [ - {}, - {}, + { + "description": "device name", + "name": "fwdevicename", + "type": "string" + }, + { + "description": "device state", + "name": "fwdevicestate", + "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", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, + { + "description": "the username that's used to log in to the external firewall", + "name": "username", + "type": "string" + }, + { + "description": "the public security zone of the external firewall", + "name": "publiczone", + "type": "string" + }, + {}, + {}, + { + "description": "the usage interface of the external firewall", + "name": "usageinterface", + "type": "string" + }, + { + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", + "type": "string" + }, + { + "description": "the management IP address of the external firewall", + "name": "ipaddress", + "type": "string" + }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "the private security zone of the external firewall", + "name": "privatezone", + "type": "string" + }, + { + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the zone ID of the external firewall", + "name": "zoneid", + "type": "string" + }, + { + "description": "the private interface of the external firewall", + "name": "privateinterface", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the public interface of the external firewall", + "name": "publicinterface", + "type": "string" + }, + { + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", + "type": "string" } ] }, { - "description": "List the virtual machines owned by the account.", - "isasync": false, - "name": "listVirtualMachines", + "description": "Creates a private gateway", + "isasync": true, + "name": "createPrivateGateway", "params": [ { - "description": "list by network id", + "description": "the Physical Network ID the network belongs to", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "the security group ID", + "description": "the VPC network belongs to", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup", - "required": false, - "since": "4.15", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": true, "type": "uuid" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "when true bypasses VLAN id/range overlap check during private gateway creation", "length": 255, - "name": "haenable", + "name": "bypassvlanoverlapcheck", "required": false, - "since": "4.15", "type": "boolean" }, { - "description": "", + "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported", "length": 255, - "name": "page", + "name": "sourcenatsupported", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list vms by iso", + "description": "The isolated network this private gateway is associated to.", "length": 255, - "name": "isoid", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, + "since": "4.17.0", "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the netmask of the Private gateway", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "netmask", + "required": true, + "type": "string" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "the IP address of the Private gateaway", "length": 255, - "name": "ids", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "since": "4.4", - "type": "list" + "name": "ipaddress", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "the uuid of the network offering to use for the private gateways network connection", "length": 255, - "name": "keyword", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "description": "the ID of the network ACL", "length": 255, - "name": "state", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "description": "the gateway of the Private gateway", "length": 255, - "name": "accumulate", - "required": false, - "since": "4.17.0", - "type": "boolean" + "name": "gateway", + "required": true, + "type": "string" }, { - "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", + "description": "the network implementation uri for the private gateway", "length": 255, - "name": "isvnf", + "name": "vlan", "required": false, - "since": "4.19.0", + "type": "string" + } + ], + "related": "createPrivateGateway,listPrivateGateways", + "response": [ + { + "description": "ACL Id set for private gateway", + "name": "aclid", + "type": "string" + }, + {}, + { + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of AutoScaling VM Group", - "length": 255, - "name": "autoscalevmgroupid", - "related": "listAutoScaleVmGroups", - "required": false, - "since": "4.18.0", - "type": "uuid" + "description": "the private gateway's netmask", + "name": "netmask", + "type": "string" }, { - "description": "list by the backup offering", - "length": 255, - "name": "backupofferingid", - "required": false, - "since": "4.17", - "type": "uuid" + "description": "VPC name the private gateway belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "type": "boolean" + "description": "path of the domain to which the private gateway belongs", + "name": "domainpath", + "type": "string" }, { - "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": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "since": "4.16.0", - "type": "uuid" + "description": "ACL name set for private gateway", + "name": "aclname", + "type": "string" }, { - "description": "the availability zone ID", - "length": 255, + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the private gateway's ip address", + "name": "ipaddress", + "type": "string" + }, + {}, + { + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", + "type": "string" + }, + { + "description": "VPC id the private gateway belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the account associated with the private gateway", + "name": "account", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the private gateway", + "name": "projectid", + "type": "string" + }, + { + "description": "Source Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" + }, + { + "description": "zone id of the private gateway", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the pod ID", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the project name of the private gateway", + "name": "project", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "description": "the domain associated with the private gateway", + "name": "domain", + "type": "string" + }, + { + "description": "the network implementation uri for the private gateway", + "name": "vlan", + "type": "string" + }, + { + "description": "the id of the private gateway", + "name": "id", + "type": "string" + } + ], + "since": "4.17.0" + }, + { + "description": "Deletes a firewall rule", + "isasync": true, + "name": "deleteFirewallRule", + "params": [ + { + "description": "the ID of the firewall rule", "length": 255, - "name": "userdata", - "required": false, - "since": "4.18.0.0", + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} + ] + }, + { + "description": "Upload a certificate to CloudStack", + "isasync": false, + "name": "uploadSslCert", + "params": [ + { + "description": "Name for the uploaded certificate", "length": 255, "name": "name", - "required": false, + "required": true, "type": "string" }, { - "description": "the host ID", + "description": "SSL certificate", + "length": 16384, + "name": "certificate", + "required": true, + "type": "string" + }, + { + "description": "domain ID of the account owning the SSL certificate", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "the group ID", + "description": "account that will own the SSL certificate", "length": 255, - "name": "groupid", - "related": "createInstanceGroup", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list vms by template", - "length": 255, - "name": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "description": "Certificate chain of trust", + "length": 2097152, + "name": "certchain", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "Private key", + "length": 16384, + "name": "privatekey", + "required": true, + "type": "string" + }, + { + "description": "an optional project for the SSL certificate", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "", + "description": "Enables revocation checking for certificates", "length": 255, - "name": "pagesize", + "name": "enabledrevocationcheck", "required": false, - "type": "integer" + "since": "4.15", + "type": "boolean" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "Password for the private key", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "password", "required": false, - "type": "uuid" + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "the ID of the virtual machine", - "length": 255, + "description": "certificate fingerprint", + "name": "fingerprint", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "certificate chain", + "name": "certchain", + "type": "string" + }, + { + "description": "SSL certificate ID", "name": "id", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by the service offering", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "since": "4.4", - "type": "uuid" + "description": "the project id of the certificate", + "name": "projectid", + "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" + "description": "account for the certificate", + "name": "account", + "type": "string" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" + }, + {}, + { + "description": "name", + "name": "name", "type": "string" }, { - "description": "flag to display the resource icon for VMs", - "length": 255, - "name": "showicon", - "required": false, - "since": "4.16.0.0", - "type": "boolean" + "description": "the project name of the certificate", + "name": "project", + "type": "string" }, { - "description": "list vms by vpc", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "certificate", + "name": "certificate", + "type": "string" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Updates the registered OAuth provider details", + "isasync": false, + "name": "updateOauthProvider", + "params": [ + { + "description": "Secret Key pre-registered in the specific OAuth provider", "length": 255, - "name": "forvirtualnetwork", + "name": "secretkey", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Description of the OAuth Provider", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Client ID pre-registered in the specific OAuth provider", "length": 255, - "name": "account", + "name": "clientid", "required": false, "type": "string" }, { - "description": "list vms by affinity group", + "description": "id of the OAuth provider to be updated", "length": 255, - "name": "affinitygroupid", - "related": "", - "required": false, + "name": "id", + "related": "updateOauthProvider", + "required": true, "type": "uuid" }, { - "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all", + "description": "Redirect URI pre-registered in the specific OAuth provider", "length": 255, - "name": "details", + "name": "redirecturi", "required": false, - "type": "list" + "type": "string" }, { - "description": "list vms by ssh keypair name", + "description": "OAuth provider will be enabled or disabled based on this value", "length": 255, - "name": "keypair", + "name": "enabled", "required": false, - "type": "string" + "type": "boolean" } ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "", "response": [ { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "Name of the provider", + "name": "provider", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" + }, + {}, + { + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" }, {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "Name of the provider", + "name": "name", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "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 list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "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 name where tag belongs to", - "name": "project", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "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" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "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 virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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 domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, { @@ -77798,735 +76561,659 @@ var preCache = `{ "type": "integer" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, + "description": "ID of the provider", + "name": "id", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Creates site to site vpn customer gateway", + "isasync": true, + "name": "createVpnCustomerGateway", + "params": [ { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "public ip address id of the customer gateway", + "length": 255, + "name": "gateway", + "required": true, + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "Force Encapsulation for NAT traversal", + "length": 255, + "name": "forceencap", + "required": false, + "type": "boolean" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", + "length": 255, + "name": "ikeversion", + "required": false, + "since": "4.15.1", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": true, "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "length": 255, + "name": "ipsecpsk", + "required": true, "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "create site-to-site VPN customer gateway for the project", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "since": "4.6", + "type": "uuid" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "IKE policy of the customer gateway", + "length": 255, + "name": "ikepolicy", + "required": true, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "length": 255, + "name": "splitconnections", + "required": false, + "since": "4.15.1", + "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "ESP policy of the customer gateway", + "length": 255, + "name": "esppolicy", + "required": true, "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "length": 255, + "name": "ikelifetime", + "required": false, "type": "long" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "If DPD is enabled for VPN connection", + "length": 255, + "name": "dpd", + "required": false, + "type": "boolean" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "name of this customer gateway", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "length": 255, + "name": "esplifetime", + "required": false, + "type": "long" + } + ], + "related": "updateVpnCustomerGateway", + "response": [ + { + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", + "description": "the domain id of the owner", "name": "domainid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, - {}, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the project name of the vm", + "description": "the project name", "name": "project", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, - {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the project id", + "name": "projectid", "type": "string" }, + {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, + {}, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "guest ip of the customer gateway", + "name": "ipaddress", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the owner", + "name": "account", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" - }, + } + ] + }, + { + "description": "remove an annotation.", + "isasync": false, + "name": "removeAnnotation", + "params": [ { - "description": "the ID of the virtual machine", + "description": "the id of the annotation", + "length": 255, "name": "id", + "required": true, "type": "string" - }, + } + ], + "related": "addAnnotation,listAnnotations", + "response": [ { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - } - ], - "type": "set" + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", + "type": "string" }, + {}, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, + {}, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "The username of the user that entered the annotation", + "name": "username", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "True if the annotation is available for admins only", + "name": "adminsonly", "type": "boolean" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.11" + }, + { + "description": "add a baremetal host", + "isasync": false, + "name": "addBaremetalHost", + "params": [ + { + "description": "the Pod ID for the host", + "length": 255, + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "comma separated list of storage access groups for the host", + "length": 255, + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", + "type": "list" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "the host URL", + "length": 255, + "name": "url", + "required": true, + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "length": 255, "name": "password", + "required": false, "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "length": 255, + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the cluster name for the host", + "length": 255, + "name": "clustername", + "required": false, "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "hypervisor type of the host", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "ip address intentionally allocated to this host after provisioning", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the cluster ID for the host", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Allocation state of this Host for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the Zone ID for the host", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "list of tags to be added to the host", + "length": 255, + "name": "hosttags", + "required": false, + "type": "list" + } + ], + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "response": [ + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, + {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "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 type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", "type": "integer" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the resource state of the host", + "name": "resourcestate", + "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 CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - } - ] - }, - { - "description": "Lists guest network IPv6 prefixes", - "isasync": false, - "name": "listGuestNetworkIpv6Prefixes", - "params": [ + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "UUID of the IPv6 prefix.", - "length": 255, - "name": "id", - "related": "listGuestNetworkIpv6Prefixes", - "required": false, - "type": "uuid" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "UUID of zone to which the IPv6 prefix belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, { - "description": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", - "type": "integer" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": " date when this IPv6 prefix was created.", - "name": "created", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", - "type": "integer" + "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 used", + "name": "memoryused", + "type": "long" }, - {}, {}, { - "description": "guest IPv6 prefix", - "name": "prefix", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "events available for the host", + "name": "events", + "type": "string" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "true if 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 Pod name of the host", + "name": "podname", "type": "string" }, { @@ -78535,1515 +77222,2045 @@ var preCache = `{ "type": "integer" }, { - "description": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", - "type": "integer" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "id of the guest IPv6 prefix", - "name": "id", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" - } - ], - "since": "4.17.0" - }, - { - "description": "Updates the information about Guest OS to Hypervisor specific name mapping", - "isasync": true, - "name": "updateGuestOsMapping", - "params": [ + }, { - "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", - "length": 255, - "name": "osmappingcheckenabled", - "required": false, - "since": "4.19.0", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" + }, + { + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the management server name of the host", + "name": "managementservername", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Hypervisor specific name for this Guest OS", - "length": 255, - "name": "osnameforhypervisor", - "required": true, + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "UUID of the Guest OS to hypervisor name Mapping", - "length": 255, - "name": "id", - "related": "updateGuestOsMapping", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, - {}, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, - {}, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" + }, + { + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "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 type", + "name": "type", + "type": "type" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the name of the host", + "name": "name", + "type": "string" + }, + { + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" + }, + {}, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the host version", + "name": "version", "type": "string" } - ], - "since": "4.4.0" + ] }, { - "description": "delete Tungsten-Fabric tag", - "isasync": true, - "name": "deleteTungstenFabricTag", + "description": "Disables a role", + "isasync": false, + "name": "disableRole", "params": [ { - "description": "the uuid of Tungsten-Fabric tag", - "length": 255, - "name": "taguuid", - "required": true, - "type": "string" - }, - { - "description": "the ID of zone", + "description": "ID of the role", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "createRole,listRoles,updateRole", "required": true, "type": "uuid" } ], "response": [ + {}, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.20.0" + }, + { + "description": "Deletes a role permission", + "isasync": false, + "name": "deleteRolePermission", + "params": [ + { + "description": "ID of the role permission", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } - ] + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ], + "since": "4.9.0" }, { - "description": "Lists all available disk offerings.", - "isasync": false, - "name": "listDiskOfferings", + "description": "Creates and automatically starts a VM from a backup.", + "isasync": true, + "name": "createVMFromBackup", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Controls specific policies on IO", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "iodriverpolicy", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "storagetype", + "name": "deploymentplanner", "required": false, - "since": "4.19", + "since": "4.4", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "account", + "name": "userdatadetails", "required": false, - "type": "string" + "since": "4.18", + "type": "map" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Enable packed virtqueues or not.", "length": 255, - "name": "isrecursive", + "name": "nicpackedvirtqueuesenabled", "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", + "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "iptonetworklist", "required": false, - "since": "4.17", - "type": "uuid" + "type": "map" }, { - "description": "listed offerings support disk encryption", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "encrypt", + "name": "networkids", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "since": "4.18", - "type": "boolean" + "type": "list" }, { - "description": "", + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", "length": 255, - "name": "pagesize", + "name": "affinitygroupids", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "integer" + "type": "list" }, { - "description": "name of the disk offering", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "name", + "name": "templateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "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, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "datadisksdetails", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "map" }, { - "description": "ID of the disk offering", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "id", - "related": "createDiskOffering,listDiskOfferings", + "name": "details", "required": false, - "type": "uuid" + "since": "4.3", + "type": "map" }, { - "description": "The ID of the volume, tags of the volume are used to filter the offerings", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "password", "required": false, - "since": "4.17", - "type": "uuid" + "since": "4.19.0.0", + "type": "string" }, { - "description": "", + "description": "an optional group for the virtual machine", "length": 255, - "name": "page", + "name": "group", "required": false, - "type": "integer" + "type": "string" }, { - "description": "id of zone disk offering is associated with", + "description": "the ID of the Userdata", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "userdataid", + "related": "listCniConfiguration", "required": false, - "since": "4.13", + "since": "4.18", "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "listall", + "name": "copyimagetags", "required": false, + "since": "4.13", "type": "boolean" }, { - "description": "List by keyword", + "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", "length": 255, - "name": "keyword", + "name": "datadiskofferinglist", "required": false, - "type": "string" - } - ], - "related": "createDiskOffering", - "response": [ - {}, - { - "description": "additional key/value details tied with this disk offering", - "name": "details", + "since": "4.11", "type": "map" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "length": 255, + "name": "securitygroupnames", + "related": "updateSecurityGroup", + "required": false, + "type": "list" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", + "description": "true if virtual machine needs to be dynamically scalable", + "length": 255, + "name": "dynamicscalingenabled", + "required": false, + "since": "4.16", "type": "boolean" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", + "length": 255, + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the mac address for default vm's network", + "length": 255, + "name": "macaddress", + "required": false, "type": "string" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", "type": "boolean" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the name of the disk offering", - "name": "name", - "type": "string" + "description": "true if start vm after creating; defaulted to true if not specified", + "length": 255, + "name": "startvm", + "required": false, + "type": "boolean" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "Use the same IP/MAC addresses as stored in the backup metadata. Works only if the original Instance is deleted and the IP/MAC address is available.", + "length": 255, + "name": "preserveip", + "required": false, + "type": "boolean" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", + "length": 255, + "name": "iothreadsenabled", + "required": false, + "type": "boolean" }, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", + "required": false, + "since": "4.12", "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" - }, - { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - {}, - { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "an optional user generated name for the virtual machine", + "length": 255, + "name": "displayname", + "required": false, "type": "string" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "the ipv6 address for default vm's network", + "length": 255, + "name": "ip6address", + "required": false, "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, - { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "The number of queues for multiqueue NICs.", + "length": 255, + "name": "nicmultiqueuenumber", + "required": false, + "since": "4.18", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "length": 255, + "name": "bootmode", + "required": false, + "since": "4.14.0.0", + "type": "string" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", + "description": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, + "name": "displayvm", + "required": false, + "since": "4.2", "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" - }, - { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" - }, - { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "availability zone for the virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "length": 255, + "name": "size", + "required": false, "type": "long" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" - }, - { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "host name for the virtual machine", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", + "length": 255, + "name": "overridediskofferingid", + "related": "", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "length": 255, + "name": "rootdisksize", + "required": false, + "since": "4.4", + "type": "long" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the ip address for default vm's network", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "since": "4.21", + "type": "uuid" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "length": 255, + "name": "affinitygroupnames", + "related": "createAffinityGroup,listAffinityGroups", + "required": false, + "type": "list" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "Number of days instance is leased for.", + "length": 255, + "name": "leaseduration", + "required": false, + "since": "4.21.0", + "type": "integer" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "name of the ssh key pair used to login to the virtual machine", + "length": 255, + "name": "keypair", + "required": false, "type": "string" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" - }, - { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "Deploy vm for the project", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "the ID of the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" - } - ] - }, - { - "description": "Update password of a host/pool on management server.", - "isasync": false, - "name": "updateHostPassword", - "params": [ - { - "description": "the new password for the host/cluster", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "type": "uuid" }, { - "description": "the host ID", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "the username for the host/cluster", + "description": "backup ID to create the VM from", "length": 255, - "name": "username", + "name": "backupid", + "related": "", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "if the password should also be updated on the hosts", + "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", "length": 255, - "name": "update_passwd_on_host", + "name": "keyboard", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the cluster ID", + "description": "used to specify the vApp properties.", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "properties", "required": false, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "since": "4.15", + "type": "map" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "names of the ssh key pairs used to login to the virtual machine", + "length": 255, + "name": "keypairs", + "required": false, + "since": "4.17", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "length": 255, + "name": "dhcpoptionsnetworklist", + "required": false, + "type": "map" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", + "required": false, + "since": "4.21", + "type": "uuid" }, - {} - ] - }, - { - "description": "adds a range of portable public IP's to a region", - "isasync": true, - "name": "createPortableIpRange", - "params": [ { - "description": "VLAN id, if not specified defaulted to untagged", + "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", "length": 255, - "name": "vlan", + "name": "securitygroupids", + "related": "updateSecurityGroup", "required": false, - "type": "string" + "type": "list" }, { - "description": "Id of the Region", + "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", - "required": true, - "type": "integer" + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the gateway for the portable IP range", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "gateway", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "the beginning IP address in the portable IP range", + "description": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "startip", - "required": true, + "name": "leaseexpiryaction", + "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "the netmask of the portable IP range", + "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", "length": 255, - "name": "netmask", - "required": true, - "type": "string" + "name": "nicnetworklist", + "required": false, + "since": "4.15", + "type": "map" }, { - "description": "the ending IP address in the portable IP range", + "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", "length": 255, - "name": "endip", - "required": true, + "name": "boottype", + "required": false, + "since": "4.14.0.0", "type": "string" } ], - "related": "", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "response": [ { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", - "type": "integer" - }, - { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", - "name": "portableipaddress", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", - "name": "state", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" } ], - "type": "list" + "type": "set" }, - {}, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the start ip of the portable IP range", - "name": "startip", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the end ip of the portable IP range", - "name": "endip", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "portable IP range ID", - "name": "id", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Lists the VMs in a VMware Datacenter", - "isasync": false, - "name": "listVmwareDcVms", - "params": [ - { - "description": "UUID of a linked existing vCenter", - "length": 255, - "name": "existingvcenterid", - "related": "addVmwareDc,listVmwareDcs", - "required": false, - "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "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 password for specified username.", - "length": 255, - "name": "password", - "required": false, + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", - "length": 255, - "name": "vcenter", - "required": false, + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "The Username required to connect to resource.", - "length": 255, - "name": "username", - "required": false, + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "Name of VMware datacenter.", - "length": 255, - "name": "datacentername", - "required": false, - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "listUnmanagedInstances", - "response": [ + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the CPU speed of the virtual machine", + "description": "the speed of each vCPU", "name": "cpuspeed", "type": "integer" }, { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, - {}, { - "description": "the list of nics associated with the virtual machine", - "name": "nic", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "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": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "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": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "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 protocol of the security group rule", + "name": "protocol", + "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "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" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" } ], "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", - "response": [ - { - "description": "the position of the disk", - "name": "position", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastoretype", - "type": "string" - }, - { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastorename", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" - }, - { - "description": "the ID of the disk", - "name": "id", - "type": "string" - }, - { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" - }, - { - "description": "the file path of the disk image", - "name": "imagepath", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "controller", - "type": "string" - }, - { - "description": "the label of the disk", - "name": "label", - "type": "string" - } - ], - "type": "set" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, - {}, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ] - }, - { - "description": "Updates an existing cluster", - "isasync": false, - "name": "updateCluster", - "params": [ + }, { - "description": "the ID of the Cluster", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "hypervisor type of the cluster", - "length": 255, - "name": "clustertype", - "required": false, + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "length": 255, - "name": "managedstate", - "required": false, + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "hypervisor type of the cluster", - "length": 255, + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", "name": "hypervisor", - "required": false, "type": "string" }, { - "description": "the cluster name", - "length": 255, - "name": "clustername", - "required": false, + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" - } - ], - "related": "addCluster", - "response": [ + }, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, {}, + {}, { - "description": "the cluster name", + "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the capacity of the Cluster", - "name": "capacity", + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the Cluster name", - "name": "clustername", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the capacity type", + "description": "the type of the affinity group", "name": "type", - "type": "short" + "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the project name of the affinity group", + "name": "project", + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the capacity name", - "name": "name", + "description": "the ID of the affinity group", + "name": "id", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, - {}, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" - } - ] - }, - { - "description": "Deletes a Cisco ASA 1000v appliance", - "isasync": false, - "name": "deleteCiscoAsa1000vResource", - "params": [ - { - "description": "Cisco ASA 1000v resource ID", - "length": 255, - "name": "resourceid", - "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" - } - ] - }, - { - "description": "Upgrades a running CloudManaged Kubernetes cluster", - "isasync": true, - "name": "upgradeKubernetesCluster", - "params": [ - { - "description": "the ID of the Kubernetes version for upgrade", - "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", - "required": true, - "type": "uuid" }, { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" - } - ], - "related": "createKubernetesCluster,startKubernetesCluster", - "response": [ - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, - {}, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "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 id of the Kubernetes cluster", - "name": "id", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, + {}, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + } + ], + "since": "4.21.0" + }, + { + "description": "Update VM Schedule.", + "isasync": false, + "name": "updateVMSchedule", + "params": [ + { + "description": "Name of the schedule", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "Enable VM schedule", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of VM schedule", + "length": 255, + "name": "id", + "related": "updateVMSchedule", + "required": true, + "type": "uuid" }, { - "description": "keypair details", - "name": "keypair", + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" + }, + { + "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "length": 255, + "name": "schedule", + "required": false, "type": "string" }, - {}, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, + { + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "length": 255, + "name": "timezone", + "required": false, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "ID of virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "Action", + "name": "action", + "type": "action" + }, + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" + }, + { + "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 name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" }, + {}, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "Cron formatted VM schedule", + "name": "schedule", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the ID of VM schedule", + "name": "id", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "Description of VM schedule", + "name": "description", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" - } - ] + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + }, + {} + ], + "since": "4.19.0" }, { - "description": "List profile in ucs manager", + "description": "Lists all configuration groups (primarily used for UI).", "isasync": false, - "name": "listUcsProfiles", + "name": "listConfigurationGroups", "params": [ { "description": "List by keyword", @@ -80052,14 +79269,6 @@ var preCache = `{ "required": false, "type": "string" }, - { - "description": "the id for the ucs manager", - "length": 255, - "name": "ucsmanagerid", - "related": "addUcsManager", - "required": true, - "type": "uuid" - }, { "description": "", "length": 255, @@ -80073,1559 +79282,1182 @@ var preCache = `{ "name": "page", "required": false, "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "ucs profile dn", - "name": "ucsdn", - "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": "Lists storage providers.", - "isasync": false, - "name": "listStorageProviders", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the type of storage provider: either primary or image", - "length": 255, - "name": "type", - "required": true, - "type": "string" }, { - "description": "List by keyword", + "description": "lists configuration group by group name", "length": 255, - "name": "keyword", + "name": "group", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "", "response": [ { - "description": "the type of the storage provider: primary or image provider", - "name": "type", + "description": "the description of the configuration group", + "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the configuration group", + "name": "name", "type": "string" }, {}, {}, { - "description": "the name of the storage provider", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the subgroups of the configuration group", + "name": "subgroup", + "response": [ + { + "description": "the precedence of the configuration subgroup", + "name": "precedence", + "type": "long" + }, + { + "description": "the name of the configuration subgroup", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the precedence of the configuration group", + "name": "precedence", + "type": "long" } - ] + ], + "since": "4.18.0" }, { - "description": "This command allows the user to query the seceret and API keys for the account", + "description": "Releases a Pod IP back to the Pod", "isasync": false, - "name": "getUserKeys", + "name": "releasePodIpAddress", "params": [ { - "description": "ID of the user whose keys are required", + "description": "UUID of the Pod IP", "length": 255, "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": true, - "type": "uuid" + "type": "long" } ], - "related": "registerUserKeys", "response": [ { - "description": "the api key of the registered user", - "name": "apikey", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the secret key of the registered user", - "name": "secretkey", + "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.10.0" + } + ] }, { - "description": "update global load balancer rules.", + "description": "Updates remote access vpn", "isasync": true, - "name": "updateGlobalLoadBalancerRule", + "name": "updateRemoteAccessVpn", "params": [ { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "gslbstickysessionmethodname", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "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": "the ID of the global load balancer rule", + "description": "id of the remote access vpn", "length": 255, "name": "id", - "related": "updateGlobalLoadBalancerRule", + "related": "createRemoteAccessVpn,listRemoteAccessVpns,updateRemoteAccessVpn", "required": true, "type": "uuid" - }, - { - "description": "load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", - "length": 255, - "name": "gslblbmethod", - "required": false, - "type": "string" } ], - "related": "", + "related": "createRemoteAccessVpn,listRemoteAccessVpns", "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the project name of the load balancer", + "description": "the project name of the vpn", "name": "project", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "List of load balancer rules that are part of GSLB rule", - "name": "loadbalancerrule", - "response": [ - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with load balancer", - "name": "tags", - "response": [ - { - "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { - "description": "global load balancer rule ID", - "name": "id", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" - }, - {} - ] + } + ], + "since": "4.4" }, { - "description": "Creates a condition for VM auto scaling", - "isasync": true, - "name": "createCondition", + "description": "Lists all available GPU devices", + "isasync": false, + "name": "listGpuDevices", "params": [ { - "description": "the domain ID of the account.", + "description": "the GPU card ID associated with the GPU device", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "gpucardid", + "related": "listGpuCards", "required": false, "type": "uuid" }, { - "description": "Value for which the Counter will be evaluated with the Operator selected.", + "description": "", "length": 255, - "name": "threshold", - "required": true, - "type": "long" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "ID of the Counter.", + "description": "the host ID where the GPU device is attached", "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", - "required": true, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": false, "type": "uuid" }, { - "description": "an optional project for condition", + "description": "the virtual machine ID to which the GPU device is allocated", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "virtualmachineid", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "required": false, "type": "uuid" }, { - "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "description": "", "length": 255, - "name": "relationaloperator", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the account of the condition. Must be used with the domainId parameter.", + "description": "the vGPU profile ID assigned to the GPU device", "length": 255, - "name": "account", + "name": "vgpuprofileid", + "related": "createVgpuProfile,updateVgpuProfile", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" + }, + { + "description": "ID of the GPU device", + "length": 255, + "name": "id", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice", + "required": false, + "type": "uuid" } ], - "related": "", + "related": "listGpuDevices,discoverGpuDevices,createGpuDevice", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host ID where the GPU device is attached", + "name": "hostid", + "type": "string" }, { - "description": "the project name of the Condition", - "name": "project", + "description": "the NUMA node where the GPU device is located", + "name": "numanode", "type": "string" }, - {}, { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the Condition.", - "name": "projectid", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", "type": "string" }, { - "description": "the owner of the Condition.", - "name": "account", + "description": "the vGPU profile name assigned to this GPU device", + "name": "virtualmachinename", "type": "string" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "the domain name of the owner.", - "name": "domain", - "type": "string" + "description": "the vGPU profile name assigned to this GPU device", + "name": "state", + "type": "state" }, { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Name of the Counter.", - "name": "countername", + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", "type": "string" }, + {}, { - "description": "zone id of counter", - "name": "zoneid", - "type": "string" + "description": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host name where the GPU device is attached", + "name": "hostname", "type": "string" }, { - "description": "the Id of the Counter.", - "name": "counterid", + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the id of the Condition", - "name": "id", + "description": "the GPU card name associated with this GPU device", + "name": "gpucardname", "type": "string" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", - "type": "string" + "description": "the state of the virtual machine to which this GPU device is allocated", + "name": "vmstate", + "type": "state" }, - {} - ] - }, - { - "description": "Lists projects and provides detailed information for listed projects", - "isasync": false, - "name": "listProjects", - "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the managed state of the GPU device (Enabled/Disabled)", + "name": "managedstate", + "type": "managedstate" }, + {}, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", "type": "string" }, { - "description": "List projects by username", - "length": 255, - "name": "username", - "required": false, + "description": "the ID of the GPU device", + "name": "id", "type": "string" }, { - "description": "flag to display the resource icon for projects", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - }, + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", + "type": "string" + } + ], + "since": "4.21.0" + }, + { + "description": "Destroys a virtual machine. Once destroyed, only the administrator can recover it.", + "isasync": true, + "name": "destroyVirtualMachine", + "params": [ { - "description": "List projects by tags (key/value pairs)", + "description": "Comma separated list of UUIDs for volumes that will be deleted", "length": 255, - "name": "tags", + "name": "volumeids", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, - "type": "map" + "since": "4.12.0", + "type": "list" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "If true is passed, the vm is expunged immediately. False by default.", "length": 255, - "name": "listall", + "name": "expunge", "required": false, + "since": "4.2.1", "type": "boolean" }, { - "description": "list projects by project ID", + "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, "type": "uuid" + } + ], + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", - "length": 255, - "name": "details", - "required": false, - "type": "list" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "list projects by display text", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "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, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "list projects by state", - "length": 255, - "name": "state", - "required": false, + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "list projects by name", - "length": 255, - "name": "name", - "required": false, + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "response": [ + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, - {}, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" - }, - {}, - { - "description": "the state of the project", - "name": "state", - "type": "string" - }, - { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the name of the project", - "name": "name", - "type": "string" - }, - { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" - }, - { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the list of resource tags associated with vm", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the id of the project", - "name": "id", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, + {}, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "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 total number of networks owned by project", - "name": "networktotal", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" - } - ], - "since": "3.0.0" - }, - { - "description": "Creates an account", - "isasync": false, - "name": "createAccount", - "params": [ - { - "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": "Unique username.", - "length": 255, - "name": "username", - "required": true, - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "email", - "length": 255, - "name": "email", - "required": true, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Creates the user under the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "Account UUID, required for adding account from external provisioning system", - "length": 255, - "name": "accountid", - "required": false, + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "Network domain for the account's networks", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.", - "length": 255, - "name": "account", - "required": false, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "lastname", - "length": 255, - "name": "lastname", - "required": true, - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "details for account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" + "description": "the project name of the vm", + "name": "project", + "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, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", - "length": 255, - "name": "password", - "required": true, + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Creates the account under the specified role.", - "length": 255, - "name": "roleid", - "related": "importRole,listRoles,updateRole", - "required": false, - "type": "uuid" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", - "length": 255, - "name": "userid", - "required": false, - "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": "firstname", - "length": 255, - "name": "firstname", - "required": true, - "type": "string" - } - ], - "related": "enableAccount,listAccounts,listAccounts", - "response": [ + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "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 number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, - {}, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, + {}, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + } + ], + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, - {}, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the user ID", + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the user email address", - "name": "email", + "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 account ID of the user", - "name": "accountid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" } ], - "type": "list" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "type": "set" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the id of the account", - "name": "id", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the state of the account", - "name": "state", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "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 total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" - } - ] - }, - { - "description": "Revert VM from a vmsnapshot.", - "isasync": true, - "name": "revertToVMSnapshot", - "params": [ - { - "description": "The ID of the vm snapshot", - "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": true, - "type": "uuid" - } - ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, - {}, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, - {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { @@ -81633,51 +80465,96 @@ var preCache = `{ "name": "securitygroup", "response": [ { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "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": "security group name", + "name": "securitygroupname", + "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" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, + { + "description": "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", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -81686,8 +80563,8 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -81696,152 +80573,144 @@ var preCache = `{ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" - }, + } + ], + "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": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ - { - "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" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, - { - "description": "the 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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -81850,13 +80719,13 @@ var preCache = `{ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -81865,270 +80734,288 @@ var preCache = `{ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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 account associated with the tag", "name": "account", "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the project name of the group", + "name": "project", + "type": "string" } ], "type": "set" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, + {}, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" - }, + } + ] + }, + { + "description": "Assigns a VM to a backup offering", + "isasync": true, + "name": "assignVirtualMachineToBackupOffering", + "params": [ { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "ID of the backup offering", + "length": 255, + "name": "backupofferingid", + "related": "listBackupOfferings,updateBackupOffering", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.14.0" + }, + { + "description": "Starts a virtual machine.", + "isasync": true, + "name": "startVirtualMachine", + "params": [ + { + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "Boot into hardware setup menu or not", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "since": "3.0.1", + "type": "uuid" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process.", + "length": 255, + "name": "considerlasthost", + "required": false, + "since": "4.18.0", + "type": "boolean" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "length": 255, + "name": "deploymentplanner", + "required": false, + "since": "4.4", "type": "string" - }, + } + ], + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "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 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": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -82137,8 +81024,8 @@ var preCache = `{ "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -82147,14 +81034,9 @@ var preCache = `{ "type": "list" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "the name of the backup offering of the virtual machine", @@ -82162,67 +81044,38 @@ var preCache = `{ "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, + {}, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "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": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, { "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 project name of the affinity group", - "name": "project", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { @@ -82235,21 +81088,6 @@ var preCache = `{ "name": "account", "type": "string" }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, { "description": "the name of the affinity group", "name": "name", @@ -82261,238 +81099,161 @@ var preCache = `{ "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "type": "list" - } - ], - "type": "set" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "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": "tag key name", - "name": "key", - "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", + "description": "the project name of the affinity group", "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the ID of the nic", - "name": "id", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", @@ -82500,1324 +81261,1183 @@ var preCache = `{ "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the type of the nic", + "name": "type", "type": "string" } ], "type": "set" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Lists host tags", - "isasync": false, - "name": "listHostTags", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the host ID of the host tag", - "name": "hostid", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, - {}, - { - "description": "the name of the host tag", - "name": "name", - "type": "string" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "the ID of the host tag", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Add a new guest OS type", - "isasync": true, - "name": "addGuestOs", - "params": [ - { - "description": "ID of Guest OS category", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": true, - "type": "uuid" - }, - { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "whether this guest OS is available for end users", - "length": 255, - "name": "forDisplay", - "required": false, - "type": "boolean" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "Optional name for Guest OS", - "length": 255, - "name": "name", - "required": false, + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "Unique display name for Guest OS", - "length": 255, - "name": "osdisplayname", - "required": true, + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "is the guest OS visible for the users", - "name": "fordisplay", - "type": "boolean" }, { - "description": "the ID of the OS category", - "name": "oscategoryid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name/description of the OS type", - "name": "description", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, - {}, { - "description": "the ID of the OS type", - "name": "id", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, - {}, { - "description": "the name of the OS type", - "name": "name", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the name of the OS category", - "name": "oscategoryname", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" - } - ], - "since": "4.4.0" - }, - { - "description": "add an annotation.", - "isasync": false, - "name": "addAnnotation", - "params": [ - { - "description": "the id of the entity to annotate", - "length": 255, - "name": "entityid", - "required": false, - "type": "string" }, { - "description": "the annotation text", - "length": 255, - "name": "annotation", - "required": false, + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER", - "length": 255, - "name": "entitytype", - "required": false, + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the annotation is visible for admins only", - "length": 255, - "name": "adminsonly", - "required": false, - "since": "4.16.0", - "type": "boolean" - } - ], - "related": "removeAnnotation,updateAnnotationVisibility", - "response": [ - { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" - }, - {}, - { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, - {}, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the contents of the annotation", - "name": "annotation", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the (uu)id of the annotation", - "name": "id", - "type": "string" - }, - { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", - "type": "string" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "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 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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "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": "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "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 name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + } + ], + "type": "set" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the type of the annotated entity", - "name": "entitytype", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" - } - ], - "since": "4.11" - }, - { - "description": "Removes a Guest OS Mapping.", - "isasync": true, - "name": "removeGuestOsMapping", - "params": [ - { - "description": "ID of the guest OS mapping", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.4.0" - }, - { - "description": "create Tungsten-Fabric service group", - "isasync": true, - "name": "createTungstenFabricServiceGroup", - "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "Tungsten-Fabric service group protocol", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, - { - "description": "Tungsten-Fabric service group name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Tungsten-Fabric service group start port", - "length": 255, - "name": "startport", - "required": true, - "type": "integer" - }, - { - "description": "Tungsten-Fabric service group end port", - "length": 255, - "name": "endport", - "required": true, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "Tungsten-Fabric service group protocol", - "name": "protocol", - "type": "string" - }, - { - "description": "Tungsten-Fabric service group end port", - "name": "endport", - "type": "int" - }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "Tungsten-Fabric service group uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "Tungsten-Fabric service group name", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone name", + "description": "the name of the availability zone for the virtual machine", "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric service group start port", - "name": "startport", - "type": "int" - } - ] - }, - { - "description": "Registers an existing ISO into the CloudStack Cloud.", - "isasync": false, - "name": "registerIso", - "params": [ - { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the URL to where the ISO is currently being hosted", - "length": 2048, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", - "length": 255, + "description": "OS type id of the vm", "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "the name of the ISO", - "length": 255, - "name": "name", - "required": true, "type": "string" }, { - "description": "the display text of the ISO, defaults to the 'name'", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", - "length": 255, - "name": "directdownload", - "required": false, - "type": "boolean" - }, - { - "description": "true if the ISO or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", - "required": false, + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "Image store UUID", - "length": 255, - "name": "imagestoreuuid", - "required": false, + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "Register ISO for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the zone you wish to register the ISO to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "true if you want this ISO to be featured", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" - }, - { - "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" - }, - { - "description": "an optional account name. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, + {}, { - "description": "true if password reset feature is supported; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" - }, - { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, - { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", - "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" - } - ], - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the account name to which the template belongs", - "name": "account", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", "type": "date" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" - }, - {}, - { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the group name of the virtual machine", + "name": "group", "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": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the status of the template", - "name": "status", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, + {}, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", + "description": "the date when this virtual machine was created", + "name": "created", "type": "date" }, { - "description": "the template ID", - "name": "id", - "type": "string" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the 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 list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, - {}, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" - }, + } + ] + }, + { + "description": "Lists the resource icon for the specified resource(s)", + "isasync": false, + "name": "listResourceIcon", + "params": [ { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, "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": "list of resources to upload the icon/image for", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" + } + ], + "related": "", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "resourceobjecttype" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, + {}, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "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 template name", - "name": "name", + "description": "base64 representation of resource icon", + "name": "base64image", "type": "string" }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - } - ] + {} + ], + "since": "4.16.0.0" }, { - "description": "Lists Cisco ASA 1000v appliances", + "description": "Creates a new Pod.", "isasync": false, - "name": "listCiscoAsa1000vResources", + "name": "createPod", "params": [ { - "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "description": "the ending IP address for the Pod", "length": 255, - "name": "hostname", + "name": "endip", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "the gateway for the Pod", "length": 255, - "name": "keyword", + "name": "gateway", "required": false, "type": "string" }, { - "description": "Cisco ASA 1000v resource ID", + "description": "the Zone ID in which the Pod will be created", "length": 255, - "name": "resourceid", - "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "the starting IP address for the Pod", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "startip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "comma separated list of storage access groups for the hosts in the pod", "length": 255, - "name": "page", + "name": "storageaccessgroups", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "list" }, { - "description": "", + "description": "Allocation state of this Pod for allocation of new resources", "length": 255, - "name": "pagesize", + "name": "allocationstate", "required": false, - "type": "integer" + "type": "string" + }, + { + "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" } ], - "related": "addCiscoAsa1000vResource", + "related": "listPods,createManagementNetworkIpRange", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, - {}, - {}, - {}, - {}, - {} - ] - }, - { - "description": "Creates new NS Vpx", - "isasync": true, - "name": "deployNetscalerVpx", - "params": [ { - "description": "availability zone for the virtual machine", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "description": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", + "type": "string" }, { - "description": "the ID of the template for the virtual machine", - "length": 255, - "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - }, - { - "description": "The network this ip address should be associated to.", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - } - ], - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter", - "response": [ - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "device state", - "name": "lbdevicestate", - "type": "string" - }, - { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", - "type": "string" - }, - { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "type": "string" - }, - {}, - { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" - }, - {}, - { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" - }, - { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" - }, - { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, - { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" - }, - { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" - }, - { - "description": "device name", - "name": "lbdevicename", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" - } - ] - }, - { - "description": "Lists the volumes of elastistor", - "isasync": false, - "name": "listElastistorVolume", - "params": [ - { - "description": "the ID of the account", - "length": 255, - "name": "id", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "synchronization", - "name": "sync", - "type": "string" - }, - { - "description": "the id of the volume", - "name": "id", - "type": "string" + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" }, - {}, - {}, { - "description": "graceallowed", - "name": "graceallowed", - "type": "string" + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "compression", - "name": "compression", + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, + {}, { - "description": "the name of the volume", - "name": "name", - "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 CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + }, + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + }, + { + "description": "the ending IP for the range", + "name": "endip", + "type": "string" + } + ], + "type": "list" }, { - "description": "deduplication", - "name": "deduplication", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "add a baremetal pxe server", - "isasync": true, - "name": "addBaremetalPxeKickStartServer", - "params": [ - { - "description": "Tftp root directory of PXE server", - "length": 255, - "name": "tftpdir", - "required": true, - "type": "string" + "description": "the capacity of the Pod", + "name": "capacity", + "response": [ + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + } + ], + "type": "list" }, { - "description": "URL of the external pxe device", - "length": 255, - "name": "url", - "required": true, + "description": "the ID of the Pod", + "name": "id", "type": "string" }, { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "password", - "required": true, + "description": "the name of the Pod", + "name": "name", "type": "string" }, { - "description": "type of pxe device", - "length": 255, - "name": "pxeservertype", - "required": true, + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "Pod Id", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "username", - "required": true, + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" } - ], - "related": "", - "response": [ - { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", - "type": "string" - }, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - {}, - { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "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": "url", - "name": "url", - "type": "string" - }, - { - "description": "device id of ", - "name": "id", - "type": "string" - }, - {} ] }, { - "description": "deletes a range of portable public IP's associated with a region", - "isasync": true, - "name": "deletePortableIpRange", + "description": "Safely removes raw records from cloud_usage table", + "isasync": false, + "name": "removeRawUsageRecords", "params": [ { - "description": "Id of the portable ip range", + "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": "id", - "related": "", + "name": "interval", "required": true, - "type": "uuid" + "type": "integer" } ], "response": [ @@ -83826,1108 +82446,1132 @@ var preCache = `{ "name": "success", "type": "boolean" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] + {} + ], + "since": "4.6.0" }, { - "description": "Lists Nicira NVP devices", - "isasync": false, - "name": "listNiciraNvpDevices", + "description": "Issues and propagates client certificate on a connected host/agent using configured CA plugin", + "isasync": true, + "name": "provisionCertificate", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the Physical Network ID", + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "provider", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "nicira nvp device ID", + "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", - "required": false, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": true, "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", + "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": "page", + "name": "reconnect", "required": false, - "type": "integer" + "type": "boolean" } ], - "related": "addNiciraNvpDevice", "response": [ - { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "device name", - "name": "niciradevicename", - "type": "string" - }, - { - "description": "the controller Ip address", - "name": "hostname", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", - "type": "string" - }, - { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", - "type": "string" - }, - { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "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": "name of the provider", - "name": "provider", - "type": "string" - }, - {}, - { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } - ] + ], + "since": "4.11.0" }, { - "description": "Lists all alerts.", + "description": "Lists VM metrics", "isasync": false, - "name": "listAlerts", + "name": "listVirtualMachinesMetrics", "params": [ { - "description": "the ID of the alert", + "description": "the availability zone ID", "length": 255, - "name": "id", - "related": "listAlerts", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "pagesize", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "list by alert name", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "name", + "name": "autoscalevmgroupid", + "related": "enableAutoScaleVmGroup", "required": false, - "since": "4.3", - "type": "string" + "since": "4.18.0", + "type": "uuid" }, { - "description": "list by alert type", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "type", + "name": "haenable", "required": false, - "type": "string" + "since": "4.15", + "type": "boolean" }, { - "description": "", + "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": "page", + "name": "listall", "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "the name of the alert", - "name": "name", - "type": "string" - }, - { - "description": "the date and time the alert was sent", - "name": "sent", - "type": "date" - }, - {}, - { - "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", - "name": "type", - "type": "short" - }, - { - "description": "the id of the alert", - "name": "id", - "type": "string" - }, - {}, - { - "description": "description of the alert", - "name": "description", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", - "isasync": true, - "name": "deployVirtualMachine", - "params": [ - { - "description": "the mac address for default vm's network", + "description": "List by keyword", "length": 255, - "name": "macaddress", + "name": "keyword", "required": false, "type": "string" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "ids", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "required": false, + "since": "4.4", "type": "list" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.", - "length": 1048576, - "name": "userdata", - "required": false, - "type": "string" - }, - { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "description": "list vms by affinity group", "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the ip address for default vm's network", + "description": "list by the service offering", "length": 255, - "name": "ipaddress", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "string" + "since": "4.4", + "type": "uuid" }, { - "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", + "description": "list vms by vpc", "length": 255, - "name": "iothreadsenabled", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=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": "nicnetworklist", + "name": "name", "required": false, - "since": "4.15", - "type": "map" + "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "The number of queues for multiqueue NICs.", + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", "length": 255, - "name": "nicmultiqueuenumber", + "name": "userdata", "required": false, - "since": "4.18", - "type": "integer" - }, - { - "description": "availability zone for the virtual machine", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "since": "4.18.0.0", + "type": "boolean" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "keypairs", + "name": "displayvm", "required": false, - "since": "4.17", - "type": "list" + "since": "4.4", + "type": "boolean" }, { - "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "description": "The ID of the Orchestrator extension for the VM", "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", "required": false, - "type": "list" + "since": "4.21.0", + "type": "uuid" }, { - "description": "an optional group for the virtual machine", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "group", + "name": "forvirtualnetwork", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, - "since": "4.13", "type": "uuid" }, { - "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", - "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup", - "required": false, - "type": "list" - }, - { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "description": "CPU arch of the VM", "length": 255, - "name": "password", + "name": "arch", "required": false, - "since": "4.19.0.0", + "since": "4.20.1", "type": "string" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "description": "", "length": 255, - "name": "size", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" }, { - "description": "Enable packed virtqueues or not.", + "description": "Whether to return only leased instances", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "leased", "required": false, - "since": "4.18", + "since": "4.21.0", "type": "boolean" }, { - "description": "Deploy vm for the project", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "the ID of the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", - "length": 255, - "name": "bootintosetup", - "required": false, - "since": "4.15.0.0", - "type": "boolean" - }, - { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", - "length": 255, - "name": "dhcpoptionsnetworklist", - "required": false, - "type": "map" - }, - { - "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", - "length": 255, - "name": "bootmode", - "required": false, - "since": "4.14.0.0", - "type": "string" - }, - { - "description": "the ID of the Userdata", + "description": "the security group ID", "length": 255, - "name": "userdataid", - "related": "", + "name": "securitygroupid", + "related": "updateSecurityGroup", "required": false, - "since": "4.18", + "since": "4.15", "type": "uuid" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "startvm", + "name": "retrieveonlyresourcecount", "required": false, "type": "boolean" }, { - "description": "used to specify the vApp properties.", + "description": "list by network id", "length": 255, - "name": "properties", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "since": "4.15", - "type": "map" + "type": "uuid" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "description": "list vms by iso", "length": 255, - "name": "affinitygroupnames", - "related": "", + "name": "isoid", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "hypervisor", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "the instances by userdata", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "userdataid", + "related": "listCniConfiguration", "required": false, - "since": "4.13", + "since": "4.20.1", "type": "uuid" }, { - "description": "Controls specific policies on IO", + "description": "list vms by ssh keypair name", "length": 255, - "name": "iodriverpolicy", + "name": "keypair", "required": false, "type": "string" }, { - "description": "the ID of the template for the virtual machine", + "description": "the ID of the virtual machine", "length": 255, - "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, + "name": "id", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, "type": "uuid" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "details", + "name": "isrecursive", "required": false, - "since": "4.3", - "type": "map" + "type": "boolean" }, { - "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", + "description": "the pod ID", "length": 255, - "name": "iptonetworklist", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", + "description": "the cluster ID", "length": 255, - "name": "overridediskofferingid", - "related": "createDiskOffering", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "since": "4.17", "type": "uuid" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "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": "copyimagetags", + "name": "accumulate", "required": false, - "since": "4.13", + "since": "4.17.0", "type": "boolean" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", - "required": false, - "since": "4.12", - "type": "string" - }, - { - "description": "used to specify the parameters values for the variables in userdata.", + "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": "userdatadetails", + "name": "isvnf", "required": false, - "since": "4.18", - "type": "map" + "since": "4.19.0", + "type": "boolean" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "the group ID", "length": 255, - "name": "deploymentplanner", + "name": "groupid", + "related": "updateInstanceGroup", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { - "description": "an optional user generated name for the virtual machine", + "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": "displayname", + "name": "state", "required": false, "type": "string" }, { - "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "datadiskofferinglist", + "name": "showicon", "required": false, - "since": "4.11", - "type": "map" + "since": "4.16.0.0", + "type": "boolean" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "description": "list vms by template", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "templateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", "length": 255, - "name": "customid", + "name": "details", "required": false, - "type": "string" + "type": "list" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "the host ID", "length": 255, "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "required": false, "type": "uuid" }, { - "description": "host name for the virtual machine", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the ipv6 address for default vm's network", - "length": 255, - "name": "ip6address", - "required": false, - "type": "string" - }, - { - "description": "true if virtual machine needs to be dynamically scalable", - "length": 255, - "name": "dynamicscalingenabled", - "required": false, - "since": "4.16", - "type": "boolean" - }, - { - "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", - "length": 255, - "name": "boottype", - "required": false, - "since": "4.14.0.0", - "type": "string" - }, - { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "keypair", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.", "length": 255, - "name": "displayvm", + "name": "gpuenabled", "required": false, - "since": "4.2", + "since": "4.21.0", "type": "boolean" }, { - "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "description": "the target hypervisor for the template", "length": 255, - "name": "keyboard", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "description": "list by the backup offering", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering", + "name": "backupofferingid", + "related": "listBackupOfferings,updateBackupOffering", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "description": "", "length": 255, - "name": "rootdisksize", + "name": "page", "required": false, - "since": "4.4", - "type": "long" + "type": "integer" } ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "listVirtualMachinesMetrics", "response": [ { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, - {}, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the total memory capacity in GiB", + "name": "memorytotal", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ + }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "network write in MiB", + "name": "networkwrite", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "network read in MiB", + "name": "networkread", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "disk read in MiB", + "name": "diskread", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the total cpu capacity in Ghz", + "name": "cputotal", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + {}, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "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 project id of the vm", + "name": "projectid", "type": "string" }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, { "description": "Vm details in key/value pairs.", "name": "details", "type": "map" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the project id of the vm", - "name": "projectid", + "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 amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, { "description": "the name of the ISO attached to the virtual machine", "name": "isoname", "type": "string" }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + {}, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "tag value", - "name": "value", - "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "tag key name", - "name": "key", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -84935,57 +83579,79 @@ var preCache = `{ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the ending IP of the security group rule ", @@ -84993,94 +83659,72 @@ var preCache = `{ "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the type of the ICMP message response", + "name": "icmptype", "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 id of the security group rule", + "name": "ruleid", + "type": "string" }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -85093,261 +83737,283 @@ var preCache = `{ "name": "domainid", "type": "string" }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" + } + ], + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "the project name where tag belongs to", + "name": "project", + "type": "string" } ], "type": "set" }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, { "description": "the list of virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", + "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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], "type": "set" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, + {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { @@ -85356,294 +84022,357 @@ var preCache = `{ "type": "integer" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "disk write in MiB", + "name": "diskwrite", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + } + ] + }, + { + "description": "Lists hosts.", + "isasync": false, + "name": "listHosts", + "params": [ { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the Zone ID for the host", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the Pod ID for the host", + "length": 255, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "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": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "uuid" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "CPU Arch of the host", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20.1", + "type": "string" }, - {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the host type", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the id of the host", + "length": 255, + "name": "id", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "type": "uuid" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "lists hosts existing in particular cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the id of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": false, + "since": "4.21.0", + "type": "uuid" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "if true, list only hosts dedicated to HA", + "length": 255, + "name": "hahost", + "required": false, + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "list hosts for which out-of-band management is enabled", + "length": 255, + "name": "outofbandmanagementenabled", + "required": false, + "type": "boolean" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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": "Upgrades router to use newer template", - "isasync": false, - "name": "upgradeRouterTemplate", - "params": [ + }, { - "description": "upgrades all routers owned by the specified domain", + "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": "domainid", - "related": "listDomainChildren,listDomains", + "name": "outofbandmanagementpowerstate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "upgrades all routers within the specified cluster", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "upgrades all routers owned by the specified account", + "description": "the state of the host", "length": 255, - "name": "account", + "name": "state", "required": false, "type": "string" }, { - "description": "upgrades router with the specified Id", + "description": "the name of the storage access group", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters", + "name": "storageaccessgroup", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "string" }, { - "description": "upgrades all routers within the specified zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "upgrades all routers within the specified pod", + "description": "", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "the name of the host", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], - "related": "", + "related": "declareHostAsDegraded,reconnectHost", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the name of the host", + "name": "name", + "type": "string" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The ID of extension for this cluster", + "name": "extensionid", + "type": "string" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + {}, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, - {} - ] - }, - { - "description": "Cancels host maintenance.", - "isasync": true, - "name": "cancelHostMaintenance", - "params": [ { - "description": "the host ID", - "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", - "response": [ + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, { "description": "the amount of the host's memory currently allocated in bytes", "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, + {}, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the Zone name of the host", + "name": "zonename", "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 Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { @@ -85652,13 +84381,13 @@ var preCache = `{ "type": "string" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "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", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { @@ -85667,79 +84396,64 @@ var preCache = `{ "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" } ], "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" } ], "type": "list" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "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 cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { @@ -85748,80 +84462,85 @@ var preCache = `{ "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "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": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, + {}, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", @@ -85829,24 +84548,24 @@ var preCache = `{ "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { "description": "the date and time the host was removed", @@ -85854,611 +84573,783 @@ var preCache = `{ "type": "date" }, { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "type": "boolean" }, - {}, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "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 amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "the date and time the host was created", + "name": "created", "type": "date" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "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": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" } ] }, { - "description": "Lists all VLAN IP ranges.", + "description": "Deletes a storage pool.", "isasync": false, - "name": "listVlanIpRanges", + "name": "deleteStoragePool", "params": [ { - "description": "true if VLAN is of Virtual type, false if Direct", + "description": "Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal)", "length": 255, - "name": "forvirtualnetwork", + "name": "forced", "required": false, "type": "boolean" }, { - "description": "", + "description": "Storage pool id", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "network id of the VLAN IP range", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone ID of the VLAN IP range", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {} + ] + }, + { + "description": "Deletes an existing guest network IPv6 prefix.", + "isasync": true, + "name": "deleteGuestNetworkIpv6Prefix", + "params": [ { - "description": "the ID of the VLAN IP range", + "description": "Id of the guest network IPv6 prefix", "length": 255, "name": "id", - "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", - "required": false, + "related": "createGuestNetworkIpv6Prefix,listGuestNetworkIpv6Prefixes", + "required": true, "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the Pod ID of the VLAN IP range", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.17.0.0" + }, + { + "description": "Updates a storage pool.", + "isasync": false, + "name": "updateStoragePool", + "params": [ + { + "description": "comma-separated list of tags for the storage pool", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "tags", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "", + "description": "IOPS CloudStack can provision from this storage pool", "length": 255, - "name": "page", + "name": "capacityiops", "required": false, - "type": "integer" + "type": "long" }, { - "description": "physical network id of the VLAN IP range", + "description": "the details for the storage pool", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "details", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "map" }, { - "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", + "description": "the URL of the storage pool", "length": 255, - "name": "vlan", + "name": "url", "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "List by keyword", + "description": "Whether the informed tag is a JS interpretable rule or not.", "length": 255, - "name": "keyword", + "name": "istagarule", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.", + "description": "false to disable the pool for allocation of new volumes, true to enable it back.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "enabled", "required": false, + "type": "boolean" + }, + { + "description": "the Id of the storage pool", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, "type": "uuid" }, { - "description": "project who will own the VLAN", + "description": "bytes CloudStack can provision from this storage pool", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "name": "capacitybytes", "required": false, - "type": "uuid" + "type": "long" + }, + { + "description": "Change the name of the storage pool", + "length": 255, + "name": "name", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.15", + "type": "string" } ], - "related": "updateVlanIpRange,dedicatePublicIpRange", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, + {}, + {}, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "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 Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, - {}, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id of the vlan range", - "name": "projectid", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the project name of the vlan range", - "name": "project", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, - {}, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the storage pool details", + "name": "details", + "type": "map" + }, + { + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "Updates a Zone.", + "description": "Lists all backup repositories", "isasync": false, - "name": "updateZone", + "name": "listBackupRepositories", "params": [ { - "description": "the first DNS for IPv6 network in the Zone", + "description": "ID of the backup repository", "length": 255, - "name": "ip6dns1", + "name": "id", + "related": "addBackupRepository,listBackupRepositories", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "ID of the zone where the backup repository is to be added", "length": 255, - "name": "allocationstate", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the details for the Zone", + "description": "", "length": 255, - "name": "details", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { - "description": "the first DNS for the Zone", + "description": "the backup repository provider", "length": 255, - "name": "dns1", + "name": "provider", "required": false, "type": "string" }, { - "description": "sort key of the zone, integer", + "description": "List by keyword", "length": 255, - "name": "sortkey", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "name of the backup repository", "length": 255, - "name": "internaldns1", + "name": "name", "required": false, "type": "string" }, { - "description": "the ID of the Zone", + "description": "", "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "addBackupRepository", + "response": [ + { + "description": "the name of the backup repository", + "name": "name", + "type": "string" + }, + {}, + {}, + { + "description": "backup type", + "name": "type", + "type": "string" + }, + { + "description": "the Zone name of the backup repository", + "name": "zonename", + "type": "string" + }, + { + "description": "capacity of the backup repository", + "name": "capacitybytes", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the address / url of the backup repository", + "name": "address", + "type": "string" + }, + { + "description": "the ID of the backup repository", "name": "id", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Zone ID of the backup repository", + "name": "zoneid", + "type": "string" + }, + { + "description": "the date and time the backup repository was added", + "name": "created", + "type": "date" + }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Lists Tungsten-Fabric tags", + "isasync": false, + "name": "listTungstenFabricTag", + "params": [ + { + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "ip6dns2", + "name": "policyuuid", "required": false, "type": "string" }, { - "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", + "description": "", "length": 255, - "name": "domain", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the name of the Zone", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "name", + "name": "networkuuid", "required": false, "type": "string" }, { - "description": "updates a private zone to public if set, but not vice-versa", + "description": "the ID of zone", "length": 255, - "name": "ispublic", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the guest CIDR address for the Zone", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "guestcidraddress", + "name": "applicationpolicysetuuid", "required": false, "type": "string" }, { - "description": "the second DNS for the Zone", + "description": "List by keyword", "length": 255, - "name": "dns2", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the dns search order list", + "description": "the uuid of Tungsten-Fabric vm", "length": 255, - "name": "dnssearchorder", + "name": "vmuuid", "required": false, - "type": "list" + "type": "string" }, { - "description": "the second internal DNS for the Zone", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "internaldns2", + "name": "taguuid", "required": false, "type": "string" }, { - "description": "the dhcp Provider for the Zone", + "description": "", "length": 255, - "name": "dhcpprovider", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "the uuid of Tungsten-Fabric nic", "length": 255, - "name": "localstorageenabled", + "name": "nicuuid", "required": false, - "type": "boolean" + "type": "string" } ], - "related": "createZone,listZones,listZones", + "related": "applyTungstenFabricTag", "response": [ + {}, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, { - "description": "Zone description", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" + } + ] + }, + { + "description": "Import LDAP users", + "isasync": false, + "name": "importLdapUsers", + "params": [ { - "description": "Zone id", - "name": "id", + "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": "the second internal DNS for the Zone", - "name": "internaldns2", - "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" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "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,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the type of the zone - core or edge", - "name": "type", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" + "description": "Creates the account under the specified role.", + "length": 255, + "name": "roleid", + "related": "createRole,listRoles,updateRole", + "required": false, + "type": "uuid" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" + "description": "details for account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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 name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "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": "Zone name", - "name": "name", + "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": "Network domain name for the networks in the zone", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "searchLdap", + "response": [ + { + "description": "The user's domain", "name": "domain", "type": "string" }, @@ -86468,1111 +85359,820 @@ var preCache = `{ "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, {}, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "The user's email", + "name": "email", "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "The user's firstname", + "name": "firstname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "The user's username", + "name": "username", + "type": "string" }, { - "description": "the capacity of the Zone", - "name": "capacity", - "response": [ - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - } - ], - "type": "list" + "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 second DNS for the Zone", - "name": "dns2", + "description": "The user's principle", + "name": "principal", "type": "string" }, + {}, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.3.0" }, { - "description": "Extracts volume", - "isasync": true, - "name": "extractVolume", + "description": "Moves a domain and its children to a new parent domain.", + "isasync": false, + "name": "moveDomain", "params": [ { - "description": "the ID of the zone where the volume is located", + "description": "The ID of the new parent domain of the domain to be moved.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "parentdomainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" }, { - "description": "the url to which the volume would be extracted", - "length": 2048, - "name": "url", - "required": false, - "type": "string" - }, - { - "description": "the ID of the volume", + "description": "The ID of the domain to be moved.", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" - }, - { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", - "length": 255, - "name": "mode", - "required": true, - "type": "string" } ], - "related": "downloadImageStoreObject,extractTemplate", + "related": "createDomain,listDomains,listDomains", "response": [ { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, - { - "description": "the id of extracted object", - "name": "id", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "type of the storage", - "name": "storagetype", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the status of the extraction", - "name": "status", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "", - "name": "resultstring", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, + {}, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "the total number of backups available to this domain", + "name": "backupavailable", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", "type": "string" }, - {}, { - "description": "the name of the extracted object", - "name": "name", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", - "type": "string" - } - ] - }, - { - "description": "Lists project's accounts", - "isasync": false, - "name": "listProjectAccounts", - "params": [ - { - "description": "list accounts of the project by role", - "length": 255, - "name": "role", - "required": false, + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "ID of the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "required": true, - "type": "uuid" - }, - { - "description": "list invitation by user ID", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "type": "uuid" - }, - { - "description": "list accounts of the project by project role id", - "length": 255, - "name": "projectroleid", - "related": "updateProjectRole", - "required": false, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "list accounts of the project by account name", - "length": 255, - "name": "account", - "required": false, + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "activateProject,suspendProject,updateProject", - "response": [ - { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, - {}, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", "type": "long" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total number of gpus the domain can own", + "name": "gpulimit", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, - {}, - { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, { - "description": "the total number of cpu cores owned by project", + "description": "the total number of cpu cores owned by domain", "name": "cputotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the total volume which can be used by this project", + "description": "the total volume which can be used by this domain", "name": "volumelimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of virtual machines deployed by this project", + "description": "the total number of virtual machines deployed by this domain", "name": "vmtotal", "type": "long" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the name of the project", - "name": "name", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated with vm", - "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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of networks owned by project", + "description": "the total number of networks owned by domain", "name": "networktotal", "type": "long" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the state of the project", - "name": "state", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of cpu cores the project can own", + "description": "the total number of cpu cores the domain can own", "name": "cpulimit", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Updates an existing autoscale policy.", - "isasync": true, - "name": "updateAutoScalePolicy", - "params": [ - { - "description": "the cool down period in which the policy should not be evaluated after the action has been taken", - "length": 255, - "name": "quiettime", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the autoscale policy", - "length": 255, - "name": "id", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "uuid" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "length": 255, - "name": "conditionids", - "related": "", - "required": false, - "type": "list" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the duration in which the conditions have to be true before action is taken", - "length": 255, - "name": "duration", - "required": false, - "type": "integer" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the name of the autoscale policy", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", - "type": "string" - } - ], - "related": "listAutoScalePolicies", - "response": [ - { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", "type": "string" }, - {}, { - "description": "name of the autoscale policy", - "name": "name", - "type": "string" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", - "type": "string" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", "type": "list" }, - {}, - { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", - "type": "integer" - }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", "type": "string" }, { - "description": "the account owning the autoscale policy", - "name": "account", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "the autoscale policy ID", - "name": "id", - "type": "string" + "description": "the total number of gpus owned by domain", + "name": "gputotal", + "type": "long" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project id autoscale policy", - "name": "projectid", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, - { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" - } - ] + {} + ], + "since": "4.19.0.0" }, { - "description": "Creates a disk offering.", + "description": "Lists all available networks.", "isasync": false, - "name": "createDiskOffering", + "name": "listNetworks", "params": [ { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "provisioningtype", + "name": "retrieveonlyresourcecount", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "list networks by restartRequired", "length": 255, - "name": "displayoffering", + "name": "restartrequired", "required": false, "type": "boolean" }, { - "description": "the storage type of the disk offering. Values are local and shared.", + "description": "", "length": 255, - "name": "storagetype", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Volumes using this offering should be encrypted", + "description": "list networks supporting certain services", "length": 255, - "name": "encrypt", + "name": "supportedservices", "required": false, - "since": "4.18", - "type": "boolean" + "type": "list" }, { - "description": "burst bytes write rate of the disk offering", + "description": "", "length": 255, - "name": "byteswriteratemax", + "name": "page", "required": false, - "type": "long" + "type": "integer" }, { - "description": "bytes write rate of the disk offering", + "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 another user. * all : all networks (account, domain and shared).", "length": 255, - "name": "byteswriterate", + "name": "networkfilter", "required": false, - "type": "long" + "since": "4.17.0", + "type": "string" }, { - "description": "max iops of the disk offering", + "description": "List by keyword", "length": 255, - "name": "maxiops", - "required": false, - "type": "long" - }, - { - "description": "An alternate display text of the disk offering, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "name": "keyword", "required": false, "type": "string" }, { - "description": "burst requests read rate of the disk offering", + "description": "true if network is system, false otherwise", "length": 255, - "name": "iopsreadratemax", + "name": "issystem", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "List networks by VPC", "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "since": "4.15", "type": "uuid" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "bytesreadratemaxlength", - "required": false, - "type": "long" - }, - { - "description": "length (in seconds) of the burst", + "description": "true if need to list only networks which support specifying IP ranges", "length": 255, - "name": "byteswriteratemaxlength", + "name": "specifyipranges", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "whether disk offering size is custom or not", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "customized", + "name": "displaynetwork", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "bytes read rate of the disk offering", + "description": "List networks by associated networks. Only available if create a Shared network.", "length": 255, - "name": "bytesreadrate", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "long" + "since": "4.17.0", + "type": "uuid" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "the zone ID of the network", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "length (in seconds) of the burst", + "description": "type of the traffic", "length": 255, - "name": "iopsreadratemaxlength", + "name": "traffictype", "required": false, - "type": "long" + "type": "string" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "disksizestrictness", + "name": "isrecursive", "required": false, - "since": "4.17", "type": "boolean" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "list networks by ACL (access control list) type. Supported values are account and domain", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "acltype", "required": false, - "type": "list" + "type": "string" }, { - "description": "min iops of the disk offering", + "description": "list networks by network offering ID", "length": 255, - "name": "miniops", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", + "description": "list networks available for VM deployment", "length": 255, - "name": "disksize", + "name": "canusefordeploy", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "flag to display the resource icon for networks", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "showicon", "required": false, - "since": "4.13", - "type": "list" + "type": "boolean" }, { - "description": "burst bytes read rate of the disk offering", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "bytesreadratemax", + "name": "projectid", + "related": "createProject", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "cachemode", + "name": "tags", "required": false, - "since": "4.14", - "type": "string" + "type": "map" }, { - "description": "name of the disk offering", + "description": "list networks by physical network id", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "io requests write rate of the disk offering", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "iopswriterate", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "burst io requests write rate of the disk offering", + "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": "iopswriteratemax", + "name": "listall", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "tags for the disk offering", - "length": 4096, - "name": "tags", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "details to specify disk offering parameters", + "description": "the ID or VID of the network", "length": 255, - "name": "details", + "name": "vlan", "required": false, - "since": "4.16", - "type": "map" + "since": "4.17.0", + "type": "string" }, { - "description": "whether disk offering iops is custom or not", + "description": "list networks by ID", "length": 255, - "name": "customizediops", + "name": "id", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "io requests read rate of the disk offering", + "description": "the network belongs to VPC", "length": 255, - "name": "iopsreadrate", + "name": "forvpc", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "the type of the network. Supported values are: isolated, l2, shared and all", "length": 255, - "name": "iopswriteratemaxlength", + "name": "type", "required": false, - "type": "long" + "type": "string" } ], - "related": "", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "response": [ { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - { - "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 vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - {}, - { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "list" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "unique ID of the disk offering", - "name": "id", - "type": "string" - }, - { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the tags for the disk offering", - "name": "tags", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, + {}, + {}, { - "description": "the name of the disk offering", - "name": "name", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, - {}, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -87580,517 +86180,641 @@ var preCache = `{ "type": "boolean" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" - } - ] - }, - { - "description": "Lists all volumes.", - "isasync": false, - "name": "listVolumes", - "params": [ + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "type": "uuid" + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", - "length": 255, - "name": "state", - "required": false, - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the name of the disk volume", - "length": 255, - "name": "name", - "required": false, + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "list volumes by disk offering", - "length": 255, - "name": "diskofferingid", - "related": "", - "required": false, - "since": "4.4", - "type": "uuid" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the ID of the storage pool, available to ROOT admin only", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "since": "4.3", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "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": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "listsystemvms", - "required": false, - "since": "4.18", + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "the type of disk volume", - "length": 255, - "name": "type", - "required": false, + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "list volumes on specified host", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the pod id the disk volume belongs to", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "displayvolume", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" }, { - "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, + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the cluster id the disk volume belongs to", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "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" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" }, { - "description": "the IDs of the volumes, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "since": "4.9", - "type": "list" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "attachVolume,createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the owner of the network", + "name": "account", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", "type": "integer" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "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": "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,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ], + "since": "4.17" + }, + { + "description": "Updates a management network IP range. Only allowed when no IPs are allocated.", + "isasync": true, + "name": "updatePodManagementNetworkIpRange", + "params": [ { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "The current starting IP address.", + "length": 255, + "name": "currentstartip", + "related": "listPods,createManagementNetworkIpRange", + "required": true, "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "The new starting IP address.", + "length": 255, + "name": "newstartip", + "required": false, "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "UUID of POD, where the IP range belongs to.", + "length": 255, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "The current ending IP address.", + "length": 255, + "name": "currentendip", + "related": "listPods,createManagementNetworkIpRange", + "required": true, + "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "The new ending IP address.", + "length": 255, + "name": "newendip", + "required": false, "type": "string" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ], + "since": "4.16.0.0" + }, + { + "description": "Adds a new OS category", + "isasync": false, + "name": "addOsCategory", + "params": [ { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "Whether the category is featured or not", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, + "description": "Name of the OS category", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "listOsCategories", + "response": [ { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "Date when the OS category was created.", + "name": "created", + "type": "date" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the OS category", + "name": "id", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "Whether the OS category is featured", + "name": "isfeatured", + "type": "boolean" }, + {}, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the name of the OS category", + "name": "name", + "type": "string" + } + ], + "since": "4.21.0" + }, + { + "description": "Updates firewall rule ", + "isasync": true, + "name": "updateFirewallRule", + "params": [ + { + "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 volume to the end user or not.", - "name": "displayvolume", + "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" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the ID of the firewall rule", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "required": true, + "type": "uuid" + } + ], + "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", + "response": [ + {}, + { + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, - {}, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -88099,8 +86823,8 @@ var preCache = `{ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -88109,47 +86833,48 @@ var preCache = `{ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], - "type": "set" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, + "type": "list" + } + ], + "since": "4.4" + }, + { + "description": "Return true if the plugin is enabled", + "isasync": false, + "name": "quotaIsEnabled", + "params": [], + "related": "", + "response": [ + {}, { - "description": "the chain info of the volume", - "name": "chaininfo", - "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", @@ -88157,1392 +86882,1184 @@ var preCache = `{ "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "is quota service enabled", + "name": "isenabled", + "type": "boolean" }, + {} + ], + "since": "4.7.0" + }, + { + "description": "Deletes the registered OAuth provider", + "isasync": false, + "name": "deleteOauthProvider", + "params": [ { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, + "description": "id of the OAuth provider to be deleted", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - } - ] + {} + ], + "since": "4.19.0" }, { - "description": "Creates a load balancer health check policy", + "description": "Creates a Bgp Peer for a zone.", "isasync": true, - "name": "createLBHealthCheckPolicy", + "name": "createBgpPeer", "params": [ { - "description": "Number of consecutive health check success before declaring an instance healthy", + "description": "The password of the Bgp Peer.", "length": 255, - "name": "healthythreshold", + "name": "password", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy", + "description": "UUID of the zone which the Bgp Peer belongs to.", "length": 255, - "name": "unhealthythreshold", - "required": false, - "type": "integer" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the ID of the load balancer rule", + "description": "project who will own the Bgp Peer", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", - "required": true, + "name": "projectid", + "related": "createProject", + "required": false, "type": "uuid" }, { - "description": "Amount of time between health checks (1 sec - 20940 sec)", + "description": "account who will own the Bgp Peer", "length": 255, - "name": "intervaltime", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", + "description": "The AS number of the Bgp Peer.", "length": 255, - "name": "responsetimeout", - "required": false, - "type": "integer" + "name": "asnumber", + "required": true, + "type": "long" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "The IPv4 address of the Bgp Peer.", "length": 255, - "name": "fordisplay", + "name": "ipaddress", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the description of the load balancer health check policy", + "description": "The IPv6 address of the Bgp Peer.", "length": 255, - "name": "description", + "name": "ip6address", "required": false, "type": "string" }, { - "description": "HTTP ping path", + "description": "BGP peer details in key/value pairs.", "length": 255, - "name": "pingpath", + "name": "details", "required": false, - "type": "string" - } - ], - "related": "listLBHealthCheckPolicies", - "response": [ - { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "type": "string" - }, - { - "description": "the list of healthcheckpolicies", - "name": "healthcheckpolicy", - "response": [ - { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "type": "string" - }, - { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" - }, - { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" - }, - { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" - }, - { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" - }, - { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" - } - ], - "type": "list" - }, - { - "description": "the account of the HealthCheck policy", - "name": "account", - "type": "string" - }, - {}, - {}, - { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "type": "map" }, { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Locks a user account", - "isasync": false, - "name": "lockUser", - "params": [ - { - "description": "Locks user by user ID.", + "description": "domain ID of the account owning the Bgp Peer", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, "type": "uuid" } ], - "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", + "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", "response": [ + {}, { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "the user ID", + "description": "id of the bgp peer", "name": "id", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the domain ID of the user", - "name": "domainid", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the api key of the user", - "name": "apikey", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, - {}, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the account name of the user", - "name": "account", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - } - ] + {} + ], + "since": "4.20.0" }, { - "description": "Checks if the Cloudian Connector is enabled", + "description": "List hypervisors", "isasync": false, - "name": "cloudianIsEnabled", - "params": [], + "name": "listHypervisors", + "params": [ + { + "description": "the zone id for listing hypervisors.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + } + ], "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the Cloudian connector enabled state", - "name": "enabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "the Cloudian Management Console base URL", - "name": "url", + "description": "Hypervisor name", + "name": "name", "type": "string" } - ], - "since": "4.11.0" + ] }, { - "description": "Lists load balancer health check policies.", - "isasync": false, - "name": "listLBHealthCheckPolicies", + "description": "Dedicates an existing Bgp Peer to an account or a domain.", + "isasync": true, + "name": "dedicateBgpPeer", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the ID of the load balancer rule", + "description": "project who will own the Bgp Peer", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "", + "description": "domain ID of the account owning the Bgp Peer", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "account who will own the Bgp Peer", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the health check policy", + "description": "Id of the Bgp Peer", "length": 255, "name": "id", - "related": "listLBHealthCheckPolicies", - "required": false, - "since": "4.4", + "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", + "required": true, "type": "uuid" } ], - "related": "", + "related": "listBgpPeers,releaseBgpPeer", "response": [ { - "description": "the list of healthcheckpolicies", - "name": "healthcheckpolicy", - "response": [ - { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "type": "string" - }, - { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" - }, - { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" - }, - { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" - }, - { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" - } - ], - "type": "list" + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the domain of the HealthCheck policy", - "name": "domain", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, + {}, { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, - {} - ], - "since": "4.2.0" - }, - { - "description": "Creates a network", - "isasync": false, - "name": "createNetwork", - "params": [ { - "description": "Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network", - "length": 255, - "name": "acltype", - "required": false, + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "the name of the network", - "length": 255, - "name": "name", - "required": true, + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "length": 255, - "name": "tungstenvirtualrouteruuid", - "required": false, + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", - "length": 255, - "name": "bypassvlanoverlapcheck", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "an optional project for the network", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, + {}, { - "description": "the first IPv4 DNS for the network", - "length": 255, - "name": "dns1", - "required": false, - "since": "4.18.0", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", - "length": 255, - "name": "endipv6", - "required": false, + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "Lists hosts metrics", + "isasync": false, + "name": "listHostsMetrics", + "params": [ { - "description": "the first IPv6 DNS for the network", + "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": "ip6dns1", + "name": "outofbandmanagementpowerstate", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "IPV6 address to be assigned to a router in a shared network", + "description": "", "length": 255, - "name": "routeripv6", + "name": "page", "required": false, - "since": "4.16", - "type": "string" + "type": "integer" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "", "length": 255, - "name": "hideipaddressusage", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the isolated private VLAN type for this network", + "description": "the name of the storage access group", "length": 255, - "name": "isolatedpvlantype", + "name": "storageaccessgroup", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "Account that will own the network. Account should be under the selected domain", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the zone ID for the network", + "description": "the Pod ID for the host", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": false, "type": "uuid" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "startipv6", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "the VPC network belongs to", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" - }, - { - "description": "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "description": "the name of the host", "length": 255, - "name": "sourcenatipaddress", + "name": "name", "required": false, - "since": "4.19", "type": "string" }, { - "description": "the network offering ID", + "description": "the id of the host", "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": true, + "name": "id", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, "type": "uuid" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks", + "description": "the Zone ID for the host", "length": 255, - "name": "ip6gateway", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the beginning IP address in the network IP range", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "startip", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the display text of the network", + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "length": 255, - "name": "displaytext", + "name": "details", "required": false, - "type": "string" + "type": "list" }, { - "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", + "description": "list hosts for which out-of-band management is enabled", "length": 255, - "name": "endip", + "name": "outofbandmanagementenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "ID of the network in an external system.", + "description": "the id of the management server", "length": 255, - "name": "externalid", + "name": "managementserverid", + "related": "listManagementServers", "required": false, - "type": "string" + "since": "4.21.0", + "type": "uuid" }, { - "description": "the second IPv4 DNS for the network", + "description": "CPU Arch of the host", "length": 255, - "name": "dns2", + "name": "arch", "required": false, - "since": "4.18.0", + "since": "4.20.1", "type": "string" }, { - "description": "The network this network is associated to. only available if create a Shared network", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "virtualmachineid", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "required": false, - "since": "4.17.0", "type": "uuid" }, { - "description": "the physical network ID the network belongs to", + "description": "the host type", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "type", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Network ACL ID associated for the network", + "description": "if true, list only hosts dedicated to HA", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "hahost", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "the state of the host", "length": 255, - "name": "netmask", + "name": "state", "required": false, "type": "string" }, { - "description": "network domain", + "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": "networkdomain", + "name": "resourcestate", "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", - "type": "integer" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", - "length": 255, - "name": "gateway", - "required": false, + "description": "the total memory allocated in GiB", + "name": "memoryallocatedgb", "type": "string" }, { - "description": "MTU to be configured on the network VR's private interface(s)", - "length": 255, - "name": "privatemtu", - "required": false, - "since": "4.18.0", - "type": "integer" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the isolated private VLAN for this network", - "length": 255, - "name": "isolatedpvlan", - "required": false, + "description": "network write in GiB", + "name": "networkwrite", "type": "string" }, { - "description": "Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified", - "length": 255, - "name": "subdomainaccess", - "required": false, + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "IPV4 address to be assigned to a router in a shared network", - "length": 255, - "name": "routerip", - "required": false, - "since": "4.16", + "description": "the total cpu used in Ghz", + "name": "cpuusedghz", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "length": 255, - "name": "displaynetwork", - "required": false, + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" + }, + { + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, { - "description": "the ID or VID of the network", - "length": 255, - "name": "vlan", - "required": false, - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the second IPv6 DNS for the network", - "length": 255, - "name": "ip6dns2", - "required": false, - "since": "4.18.0", - "type": "string" + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" }, { - "description": "domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" }, { - "description": "the CIDR of IPv6 network, must be at least /64", - "length": 255, - "name": "ip6cidr", - "required": false, + "description": "the admin that annotated this host", + "name": "username", "type": "string" - } - ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "response": [ + }, + {}, { - "description": "the network's netmask", - "name": "netmask", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "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 type of the network", - "name": "type", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "out-of-band management power state", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "network read in GiB", + "name": "networkread", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the total memory used in GiB", + "name": "memoryusedgb", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", "type": "boolean" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", "type": "boolean" }, - { - "description": "the name of the network", - "name": "name", - "type": "string" - }, {}, { - "description": "zone id of the network", - "name": "zoneid", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, - {}, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, + {}, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "instances on the host", + "name": "instances", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the total memory capacity in GiB", + "name": "memorytotalgb", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the total cpu capacity in Ghz", + "name": "cputotalghz", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "system vm instances on the host", + "name": "systeminstances", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "the total cpu allocated in Ghz", + "name": "cpuallocatedghz", "type": "string" }, { - "description": "the list of services", - "name": "service", + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroup", "response": [ { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" }, { - "description": "the service provider name", - "name": "provider", + "description": "the list of enabled vGPUs", + "name": "vgpu", "response": [ { - "description": "uuid of the network provider", - "name": "id", + "description": "Model Name of vGPU", + "name": "vgputype", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" }, { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the provider name", - "name": "name", - "type": "string" + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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 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": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" + }, + { + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" } - ] + ], + "since": "4.9.3" }, { - "description": "Lists all available network offerings.", - "isasync": false, - "name": "listNetworkOfferings", + "description": "Release the dedication for the pod", + "isasync": true, + "name": "releaseDedicatedPod", "params": [ { - "description": "true if need to list only network offerings which support specifying ip ranges", + "description": "the ID of the Pod", "length": 255, - "name": "specifyipranges", - "required": false, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "list network offerings by display text", - "length": 255, + "description": "any text associated with the success or failure", "name": "displaytext", - "required": false, "type": "string" }, + {}, { - "description": "list network offerings by name", - "length": 255, - "name": "name", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the network offering can be used only for network creation inside the VPC", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Cancels a triggered shutdown", + "isasync": false, + "name": "cancelShutdown", + "params": [ + { + "description": "the id of the management server", "length": 255, - "name": "forvpc", - "required": false, + "name": "managementserverid", + "related": "listManagementServers", + "required": true, + "type": "uuid" + } + ], + "related": "prepareForShutdown,readyForShutdown", + "response": [ + { + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", "type": "boolean" }, { - "description": "true if need to list only default network offerings. Default value is false", - "length": 255, - "name": "isdefault", - "required": false, + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + }, + {}, + { + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", + "type": "long" + }, + { + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" + }, + { + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", "type": "boolean" }, { - "description": "list by traffic type", - "length": 255, - "name": "traffictype", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "The id of the management server", + "name": "managementserverid", + "type": "string" }, { - "description": "list network offerings by tags", - "length": 4096, - "name": "tags", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" }, + {} + ], + "since": "4.19.0" + }, + { + "description": "Lists affinity groups", + "isasync": false, + "name": "listAffinityGroups", + "params": [ { "description": "", "length": 255, @@ -89551,175 +88068,129 @@ var preCache = `{ "type": "integer" }, { - "description": "list network offerings by ID", + "description": "list the affinity group by the ID provided", "length": 255, "name": "id", - "related": "listNetworkOfferings", - "required": false, - "type": "uuid" - }, - { - "description": "list network offerings available for network creation in specific domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "since": "4.13", "type": "uuid" }, { - "description": "list network offerings by state", + "description": "lists affinity groups by name", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, { - "description": "list network offerings supporting certain services", + "description": "lists affinity groups by virtual machine ID", "length": 255, - "name": "supportedservices", + "name": "virtualmachineid", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "list network offerings available for network creation in specific zone", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "the availability of network offering. Default value is required", + "description": "", "length": 255, - "name": "availability", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list network offerings by guest type: shared or isolated", + "description": "List by keyword", "length": 255, - "name": "guestiptype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "true if offering has tags specified", + "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": "istagged", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "the tags for the network offering.", + "description": "lists affinity groups by type", "length": 255, - "name": "specifyvlan", + "name": "type", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "sourcenatsupported", + "name": "isrecursive", "required": false, "type": "boolean" } ], - "related": "", + "related": "createAffinityGroup", "response": [ { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" - }, - { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "type": "boolean" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "the name of the network offering", - "name": "name", - "type": "string" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the id of the network offering", - "name": "id", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, + {}, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" - }, - { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -89727,461 +88198,296 @@ var preCache = `{ "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, - { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" - }, {}, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the tags for the network offering", - "name": "tags", - "type": "string" - }, - { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "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" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - } - ], + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "type": "list" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "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": "availability of the network offering", - "name": "availability", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the project name of the affinity group", + "name": "project", "type": "string" - }, - { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" } ] }, { - "description": "Lists dedicated pods.", + "description": "Register a public key in a keypair under a certain name", "isasync": false, - "name": "listDedicatedPods", + "name": "registerSSHKeyPair", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the ID of the domain associated with the pod", + "description": "an optional project for the ssh key", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "the ID of the pod", + "description": "Name of the keypair", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the name of the account associated with the pod. Must be used with domainId.", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "Public key material of the keypair", + "length": 5120, + "name": "publickey", + "required": true, + "type": "string" }, { - "description": "list dedicated pods by affinity group", + "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], - "related": "", + "related": "listSSHKeyPairs", "response": [ { - "description": "the ID of the Pod", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", + "description": "the owner of the keypair", + "name": "account", "type": "string" }, - {}, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, {}, - { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the Name of the Pod", - "name": "podname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the ssh keypair", + "name": "id", + "type": "string" + }, + { + "description": "the domain id of the keypair owner", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "Name of the keypair", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the keypair owner", + "name": "project", "type": "string" } ] }, { - "description": "Attempts Migration of a VM with its volumes to a different host", - "isasync": true, - "name": "migrateVirtualMachineWithVolume", + "description": "Reserve a public IP to an account.", + "isasync": false, + "name": "reserveIpAddress", "params": [ { - "description": "Automatically select a destination host for a running instance, if hostId is not specified. false by default", + "description": "the ID of the domain to reserve with this IP address", "length": 255, - "name": "autoselect", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "the account to reserve with this IP address", "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" }, { - "description": "Destination Host ID to migrate VM to.", + "description": "the ID of the project to reserve with this IP address", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=&migrateto[volume-index].pool=Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume= indicates the UUID of the volume that you want to migrate, and pool= indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", + "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, - "name": "migrateto", + "name": "fordisplay", "required": false, - "type": "map" + "type": "boolean" + }, + { + "description": "the ID of the public IP address to reserve", + "length": 255, + "name": "id", + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" } ], - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the account the public IP address is associated with", + "name": "account", "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": "OS name of the vm", - "name": "osdisplayname", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", + "description": "date the public IP address was acquired", + "name": "allocated", "type": "date" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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 user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, {}, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "true if range is dedicated for external network providers", + "name": "forprovider", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with ip address", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -90195,8 +88501,8 @@ var preCache = `{ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -90205,13 +88511,13 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -90223,1234 +88529,785 @@ var preCache = `{ "description": "resource type", "name": "resourcetype", "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], - "type": "set" + "type": "list" }, - {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, + {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the name of the Network where ip belongs to", + "name": "networkname", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - } - ], - "type": "set" + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "public IP address id", + "name": "id", "type": "string" - }, + } + ], + "since": "4.17" + }, + { + "description": "Delete one or more events.", + "isasync": false, + "name": "deleteEvents", + "params": [ { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "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": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the IDs of the events", + "length": 255, + "name": "ids", + "related": "", + "required": false, + "type": "list" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "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": "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": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" + } + ] + }, + { + "description": "Deletes an ISO file.", + "isasync": true, + "name": "deleteIso", + "params": [ + { + "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": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the ISO file", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + } + ], + "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": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "Lists VPC offerings", + "isasync": false, + "name": "listVPCOfferings", + "params": [ + { + "description": "list VPC offerings by id", + "length": 255, + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", + "required": false, + "type": "uuid" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "list VPC offerings by name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "list VPC offerings available for VPC creation in specific domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "since": "4.18", + "type": "uuid" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "true if need to list only default VPC offerings. Default value is false", + "length": 255, + "name": "isdefault", + "required": false, + "type": "boolean" + }, + { + "description": "list VPC offerings by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "list VPC offerings supporting certain services", + "length": 255, + "name": "supportedservices", + "required": false, + "type": "list" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "id of zone VPC offering is associated with", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "since": "4.13", + "type": "uuid" + }, + { + "description": "list VPC offerings by display text", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + } + ], + "related": "updateVPCOffering", + "response": [ + { + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" + }, + { + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "the id of the vpc offering", + "name": "id", + "type": "string" + }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of supported services", + "name": "service", "response": [ { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "state of the network provider", + "name": "state", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "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" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" } ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "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 traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "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 gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the service name", + "name": "name", "type": "string" } ], - "type": "set" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "type": "list" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "true if vpc offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, + {}, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", "type": "boolean" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the name of the virtual machine", + "description": "the name of the vpc offering", "name": "name", "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" } ] }, { - "description": "Lists VPCs", + "description": "Get the SF volume size including Hypervisor Snapshot Reserve", "isasync": false, - "name": "listVPCs", + "name": "getSolidFireVolumeSize", "params": [ { - "description": "list by ID of the VPC offering", - "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", - "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 objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "list by name of the VPC", + "description": "Volume UUID", "length": 255, - "name": "name", - "required": false, + "name": "volumeid", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "list VPCs by state", - "length": 255, - "name": "state", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", - "length": 255, - "name": "cidr", - "required": false, - "type": "string" - }, + "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", + "name": "solidFireVolumeSize", + "type": "long" + } + ] + }, + { + "description": "Uploads a data disk.", + "isasync": true, + "name": "uploadVolume", + "params": [ { - "description": "flag to display the resource icon for VPCs", + "description": "the checksum value of this volume. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "showicon", + "name": "checksum", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list VPC by id", + "description": "the ID of the zone the volume is to be hosted on", "length": 255, - "name": "id", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "list VPC supporting certain services", + "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" + "name": "format", + "required": true, + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "Image store uuid", "length": 255, - "name": "tags", + "name": "imagestoreuuid", "required": false, - "type": "map" + "type": "string" }, { - "description": "List by keyword", + "description": "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", "length": 255, - "name": "keyword", + "name": "diskofferingid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then volume will be assigned to the caller account and domain.", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "List by display text of the VPC", + "description": "the name of the volume", "length": 255, - "name": "displaytext", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Upload volume for the project", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "createProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "an optional accountName. Must be used with domainId.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "list by zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "list VPCs by restartRequired option", - "length": 255, - "name": "restartrequired", - "required": false, - "type": "boolean" + "description": "the URL of where the volume is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, + "type": "string" } ], - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "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": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the name of the VPC", - "name": "name", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the owner of the VPC", - "name": "account", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the id of the VPC", - "name": "id", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, - {}, { - "description": "the list of resource tags associated with the project", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -91458,24 +89315,34 @@ var preCache = `{ "name": "project", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, { "description": "customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -91484,430 +89351,422 @@ var preCache = `{ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { "description": "tag key name", "name": "key", "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" } ], - "type": "list" - } - ] - }, - { - "description": "Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer", - "isasync": false, - "name": "addNetworkDevice", - "params": [ + "type": "set" + }, { - "description": "parameters for network device", - "length": 255, - "name": "networkdeviceparameterlist", - "required": false, - "type": "map" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", - "length": 255, - "name": "networkdevicetype", - "required": false, + "description": "pod name of the volume", + "name": "podname", "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "the ID of the network device", - "name": "id", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" - } - ] - }, - { - "description": "Execute network-utility command (ping/arping/tracert) on system VMs remotely", - "isasync": true, - "name": "runDiagnostics", - "params": [ + }, { - "description": "Additional command line options that apply for each command", - "length": 255, - "name": "params", - "required": false, - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "The IP/Domain address to test connection to", - "length": 255, - "name": "ipaddress", - "required": true, + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", - "length": 255, - "name": "type", - "required": true, + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "The ID of the system VM instance to diagnose", - "length": 255, - "name": "targetid", - "related": "migrateSystemVm,startSystemVm", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, { - "description": "the standard output from the command execution", - "name": "stdout", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the command execution return code", - "name": "exitcode", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the standard error output from the command execution", - "name": "stderr", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, - {} - ], - "since": "4.12.0.0" - }, - { - "description": "Updates a user account", - "isasync": false, - "name": "updateUser", - "params": [ { - "description": "first name", - "length": 255, - "name": "firstname", - "required": false, + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "email", - "length": 255, - "name": "email", - "required": false, + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "User uuid", - "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", - "required": true, - "type": "uuid" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "The secret key for the user. Must be specified with userApiKey", - "length": 255, - "name": "usersecretkey", - "required": false, + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "Unique username", - "length": 255, - "name": "username", - "required": false, + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA", - "length": 255, - "name": "mandate2fa", - "required": false, - "since": "4.18.0.0", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "The API key for the user. Must be specified with userSecretKey", - "length": 255, - "name": "userapikey", - "required": false, + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "last name", - "length": 255, - "name": "lastname", - "required": false, + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", - "length": 255, - "name": "password", - "required": false, + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "Current password that was being used by the user. You must inform the current password when updating the password.", - "length": 255, - "name": "currentpassword", - "required": false, + "description": "the project id of the vpn", + "name": "projectid", "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" - } - ], - "related": "createUser,disableUser,enableUser,getUser,listUsers", - "response": [ + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, { - "description": "the user lastname", - "name": "lastname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the account type of the user", - "name": "accounttype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the user ID", - "name": "id", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, + {} + ] + }, + { + "description": "Configures a host's out-of-band management interface", + "isasync": false, + "name": "configureOutOfBandManagement", + "params": [ { - "description": "the ID of the role", - "name": "roleid", + "description": "the host management interface IP address", + "length": 255, + "name": "address", + "required": true, "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the host management interface user", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": true, + "type": "uuid" + }, + { + "description": "the host management interface port", + "length": 255, + "name": "port", + "required": true, "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the host management interface driver, for example: ipmitool", + "length": 255, + "name": "driver", + "required": true, "type": "string" }, + { + "description": "the host management interface password", + "length": 255, + "name": "password", + "required": true, + "type": "string" + } + ], + "related": "enableOutOfBandManagementForHost,changeOutOfBandManagementPassword", + "response": [ {}, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the user email address", - "name": "email", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "the account name of the user", - "name": "account", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, + {}, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the operation result description", + "name": "description", + "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "4.9.0" }, { - "description": "Restarts a VPC", - "isasync": true, - "name": "restartVPC", + "description": "Lists storage tags", + "isasync": false, + "name": "listStorageTags", "params": [ { - "description": "the id of the VPC", - "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" - }, - { - "description": "If cleanup old network elements", + "description": "List by keyword", "length": 255, - "name": "cleanup", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Turn a single VPC into a redundant one.", + "description": "", "length": 255, - "name": "makeredundant", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "description": "", "length": 255, - "name": "livepatch", + "name": "page", "required": false, - "since": "4.17.0", - "type": "boolean" + "type": "integer" } ], + "related": "", "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the pool ID of the storage tag", + "name": "poolid", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the storage tag", + "name": "id", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "the name of the storage tag", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ] }, { - "description": "Removes a certificate from a load balancer rule", - "isasync": true, - "name": "removeCertFromLoadBalancer", + "description": "Delete VM Schedule.", + "isasync": false, + "name": "deleteVMSchedule", "params": [ { - "description": "the ID of the load balancer rule", + "description": "ID of VM schedule", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", + "name": "id", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "ID of VM", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "required": true, "type": "uuid" + }, + { + "description": "IDs of VM schedule", + "length": 255, + "name": "ids", + "related": "", + "required": false, + "type": "list" } ], "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", @@ -91918,120 +89777,85 @@ var preCache = `{ "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } - ] + }, + {} + ], + "since": "4.19.0" }, { - "description": "Adds a new host.", - "isasync": false, - "name": "addHost", + "description": "Creates a IPv4 subnet for guest networks.", + "isasync": true, + "name": "createIpv4SubnetForGuestNetwork", "params": [ { - "description": "the Zone ID for the host", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "Allocation state of this Host for allocation of new resources", + "description": "the CIDR size of IPv4 network. This is mutually exclusive with subnet.", "length": 255, - "name": "allocationstate", + "name": "cidrsize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the Pod ID for the host", + "description": "The zone Ipv4 subnet which the IPv4 subnet belongs to.", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "parentid", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", "required": true, "type": "uuid" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "The CIDR of this Ipv4 subnet.", "length": 255, - "name": "username", + "name": "subnet", "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", - "length": 255, - "name": "password", - "required": false, + "description": "id of the data center IPv4 subnet", + "name": "parentid", "type": "string" }, { - "description": "the cluster name for the host", - "length": 255, - "name": "clustername", - "required": false, + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" }, { - "description": "hypervisor type of the host", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "list of tags to be added to the host", - "length": 255, - "name": "hosttags", - "required": false, - "type": "list" - }, - { - "description": "the host URL", - "length": 255, - "name": "url", - "required": true, + "description": "Name of the VPC which the IPv4 subnet is associated with.", + "name": "vpcname", "type": "string" }, { - "description": "the cluster ID for the host", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" - } - ], - "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", - "response": [ - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "date when this IPv4 subnet was removed.", + "name": "removed", + "type": "date" }, + {}, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", + "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "id of network which the IPv4 subnet is associated with.", + "name": "networkid", + "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the 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", @@ -92039,597 +89863,607 @@ var preCache = `{ "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "subnet of the IPv4 network", + "name": "subnet", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "id of the IPv4 subnet for guest network", + "name": "id", + "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "Id of the VPC which the IPv4 subnet is associated with.", + "name": "vpcid", + "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 displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", + "type": "date" + } + ], + "since": "4.20.0" + }, + { + "description": "List template visibility and all accounts that have permissions to view this template.", + "isasync": false, + "name": "listTemplatePermissions", + "params": [ { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, + "description": "the template ID", + "length": 255, + "name": "id", + "related": "listIsoPermissions,listTemplatePermissions,listTemplatePermissions,listIsoPermissions", + "required": true, + "type": "uuid" + } + ], + "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", + "response": [ + {}, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the list of accounts the template is available for", + "name": "account", + "type": "list" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the template ID", + "name": "id", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the list of projects the template is available for", + "name": "projectids", + "type": "list" }, + {} + ] + }, + { + "description": "Lists annotations.", + "isasync": false, + "name": "listAnnotations", + "params": [ { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the entity type", + "length": 255, + "name": "entitytype", + "required": false, "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "optional: the id of the user of the annotation", + "length": 255, + "name": "userid", + "required": false, + "since": "4.16.0", + "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the id of the entity for which to show annotations", + "length": 255, + "name": "entityid", + "required": false, "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the id of the annotation", + "length": 255, + "name": "id", + "required": false, "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "possible values are \"self\" and \"all\". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can access", + "length": 255, + "name": "annotationfilter", + "required": false, + "since": "4.16.0", "type": "string" - }, + } + ], + "related": "addAnnotation", + "response": [ { - "description": "the date and time the host was last pinged", - "name": "lastpinged", + "description": "the creation timestamp for this annotation", + "name": "created", "type": "date" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", + "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the type of the annotated entity", + "name": "entitytype", + "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, + {}, + {}, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.11" + }, + { + "description": "Adds Swift.", + "isasync": false, + "name": "addSwift", + "params": [ { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the URL for swift", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": " key for the user for swift", + "length": 255, + "name": "key", + "required": false, + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the account for swift", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the username for swift", + "length": 255, + "name": "username", + "required": false, "type": "string" - }, + } + ], + "related": "addSecondaryStorage,listSwifts,addImageStore", + "response": [ { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, + {}, { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the url of the image store", + "name": "url", + "type": "string" }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - } - ] + {} + ], + "since": "3.0.0" }, { - "description": "Attaches a disk volume to a virtual machine.", - "isasync": true, - "name": "attachVolume", + "description": "Updates a vGPU profile in the system", + "isasync": false, + "name": "updateVgpuProfile", "params": [ { - "description": " the ID of the virtual machine", + "description": "the video RAM size in MB", "length": 255, - "name": "virtualmachineid", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "videoram", + "required": false, + "type": "long" }, { - "description": "the ID of the disk volume", + "description": "the maximum X resolution", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "name": "maxresolutionx", + "required": false, + "type": "long" }, { - "description": "The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.
When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:
  • 0 maps to /dev/xvda;
  • 1 maps to /dev/xvdb;
  • 2 maps /dev/xvdc and so on.
Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure.", + "description": "the maximum number of display heads", "length": 255, - "name": "deviceid", + "name": "maxheads", "required": false, "type": "long" - } - ], - "related": "createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the description of the vGPU profile", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "the ID of the vGPU profile", + "length": 255, + "name": "id", + "related": "createVgpuProfile,updateVgpuProfile", + "required": true, + "type": "uuid" }, - {}, { - "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 maximum number of vGPUs per physical GPU", + "length": 255, + "name": "maxvgpuperphysicalgpu", + "required": false, + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the name of the vGPU profile", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, + "description": "the maximum Y resolution", + "length": 255, + "name": "maxresolutiony", + "required": false, + "type": "long" + } + ], + "related": "createVgpuProfile", + "response": [ { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "the maximum number of vGPUs per physical GPU", + "name": "maxvgpuperphysicalgpu", + "type": "long" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the vendor ID of the GPU card", + "name": "vendorid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the vendor name of the GPU card", + "name": "vendorname", "type": "string" }, + {}, + {}, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the name of the vGPU profile", + "name": "gpucardname", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the ID of the GPU card", + "name": "id", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the device ID of the GPU card", + "name": "deviceid", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the display name of the GPU card", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the GPU card associated with this vGPU profile", + "name": "gpucardid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the device name of the GPU card", + "name": "devicename", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the description of the vGPU profile", + "name": "description", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.21.0" + }, + { + "description": "Lists snapshot policies.", + "isasync": false, + "name": "listSnapshotPolicies", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the ID of the snapshot policy", + "length": 255, + "name": "id", + "related": "updateSnapshotPolicy,listSnapshotPolicies", + "required": false, + "type": "uuid" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "type": "uuid" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + } + ], + "related": "updateSnapshotPolicy", + "response": [ + {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "The list of pools in which snapshot backup is scheduled", + "name": "storage", + "type": "set" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -92643,1521 +90477,1773 @@ var preCache = `{ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, + {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + } + ] + }, + { + "description": "Update site to site vpn customer gateway", + "isasync": true, + "name": "updateVpnCustomerGateway", + "params": [ + { + "description": "Force encapsulation for Nat Traversal", + "length": 255, + "name": "forceencap", + "required": false, + "type": "boolean" + }, + { + "description": "name of this customer gateway", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "length": 255, + "name": "splitconnections", + "required": false, + "since": "4.15.1", + "type": "boolean" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", + "length": 255, + "name": "ikeversion", + "required": false, + "since": "4.15.1", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "length": 255, + "name": "ipsecpsk", + "required": true, "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "id of customer gateway", + "length": 255, + "name": "id", + "related": "updateVpnCustomerGateway", + "required": true, + "type": "uuid" + }, + { + "description": "ESP policy of the customer gateway", + "length": 255, + "name": "esppolicy", + "required": true, "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "length": 255, + "name": "esplifetime", + "required": false, + "type": "long" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "length": 255, + "name": "ikelifetime", + "required": false, "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "If DPD is enabled for VPN connection", + "length": 255, + "name": "dpd", + "required": false, + "type": "boolean" + }, + { + "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": true, "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "public ip address id of the customer gateway", + "length": 255, + "name": "gateway", + "required": true, "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "IKE policy of the customer gateway", + "length": 255, + "name": "ikepolicy", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + {}, + { + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the project name", + "name": "project", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "IPsec policy of customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "guest ip of the customer gateway", + "name": "ipaddress", + "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, { - "description": "adds a baremetal dhcp server", + "description": "apply Tungsten-Fabric tag", "isasync": true, - "name": "addBaremetalDhcp", + "name": "applyTungstenFabricTag", "params": [ { - "description": "the Physical Network ID", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "applicationpolicysetuuid", + "required": false, + "type": "string" + }, + { + "description": "the uuid of networks", + "length": 255, + "name": "networkuuid", + "required": false, + "type": "list" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "URL of the external dhcp appliance.", + "description": "the uuid of nics", "length": 255, - "name": "url", - "required": true, - "type": "string" + "name": "nicuuid", + "required": false, + "type": "list" }, { - "description": "Credentials to reach external dhcp device", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "username", + "name": "taguuid", "required": true, "type": "string" }, { - "description": "Credentials to reach external dhcp device", + "description": "the uuid of vms", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "vmuuid", + "required": false, + "type": "list" }, { - "description": "Type of dhcp device", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "dhcpservertype", - "required": true, + "name": "policyuuid", + "required": false, "type": "string" } ], - "related": "listBaremetalDhcp", + "related": "", "response": [ + { + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "device id of ", - "name": "id", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "url", - "name": "url", - "type": "string" + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" }, {}, { - "description": "name of the provider", - "name": "dhcpservertype", - "type": "string" + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" }, - {}, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { - "description": "delete Tungsten-Fabric application policy set", - "isasync": true, - "name": "deleteTungstenFabricApplicationPolicySet", + "description": "Updates object storage pool", + "isasync": false, + "name": "updateObjectStoragePool", "params": [ { - "description": "the ID of zone", + "description": "the name for the object store", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "the url for the object store", "length": 255, - "name": "applicationpolicysetuuid", - "required": true, + "name": "url", + "required": false, "type": "string" + }, + { + "description": "the total size of the object store in GiB. Used for tracking capacity and sending alerts. Set to 0 to stop tracking.", + "length": 255, + "name": "size", + "required": false, + "since": "4.21", + "type": "long" + }, + { + "description": "Object Store ID", + "length": 255, + "name": "id", + "related": "addObjectStoragePool,updateObjectStoragePool", + "required": true, + "type": "uuid" } ], + "related": "addObjectStoragePool", "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the object store currently used size", + "name": "storageused", + "type": "long" }, { "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 url of the object store", + "name": "url", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {} - ] + { + "description": "the ID of the object store", + "name": "id", + "type": "string" + }, + { + "description": "the total size of the object store", + "name": "storagetotal", + "type": "long" + }, + { + "description": "the name of the object store", + "name": "name", + "type": "string" + }, + { + "description": "the provider name of the object store", + "name": "providername", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the allocated size of the object store", + "name": "storageallocated", + "type": "long" + } + ], + "since": "4.19.0" }, { - "description": "Copies a snapshot from one zone to another.", - "isasync": true, - "name": "copySnapshot", + "description": "Register an extension with a resource", + "isasync": false, + "name": "registerExtension", "params": [ { - "description": "The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used.", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", "length": 255, - "name": "sourcezoneid", - "related": "createZone,listZones,listZones", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the ID of the snapshot.", + "description": "Type of the resource", "length": 255, - "name": "id", - "related": "copySnapshot,revertSnapshot,listSnapshots", + "name": "resourcetype", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The ID of the zone the snapshot is being copied to.", + "description": "ID of the resource to register the extension with", "length": 255, - "name": "destzoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" + "name": "resourceid", + "required": true, + "type": "string" }, { - "description": "A comma-separated list of IDs of the zones that the snapshot needs to be copied to. Specify this list if the snapshot needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "description": "ID of the extension", "length": 255, - "name": "destzoneids", - "related": "createZone,listZones,listZones", - "required": false, - "type": "list" + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", + "required": true, + "type": "uuid" } ], - "related": "revertSnapshot,listSnapshots", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Description of the extension", + "name": "description", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "The path of the entry point fo the extension", + "name": "path", "type": "string" }, + { + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" + }, + { + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" + }, {}, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "ID of the extension", + "name": "id", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "Name of the extension", + "name": "name", "type": "string" }, - {}, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "List of resources to which extension is registered to", + "name": "resources", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "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": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the details of the resource map", + "name": "details", + "type": "map" }, { - "description": "tag value", - "name": "value", + "description": "Name of the resource associated with this mapping", + "name": "name", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "ID of the resource associated with the extension", + "name": "id", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Type of the resource", + "name": "type", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" } ], - "type": "set" + "type": "list" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "Type of the extension", + "name": "type", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", - "type": "string" + "description": "The details of the extension", + "name": "details", + "type": "map" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The state of the extension", + "name": "state", + "type": "string" }, + {} + ], + "since": "4.21.0" + }, + { + "description": "This deprecated function used to locks an account. Look for the API DisableAccount instead", + "isasync": false, + "name": "lockAccount", + "params": [ { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "Locks the specified account.", + "length": 255, + "name": "account", + "required": true, "type": "string" }, { - "description": " the date the snapshot was created", + "description": "Locks the specified account on this domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" + } + ], + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "response": [ + { + "description": "the date when this account was created", "name": "created", "type": "date" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", - "type": "string" + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", + "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + } + ], + "type": "list" }, { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", "type": "long" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Adds Traffic Monitor Host for Direct Network Usage", - "isasync": false, - "name": "addTrafficMonitor", - "params": [ + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, { - "description": "Traffic going into the listed zones will be metered", - "length": 255, - "name": "includezones", - "required": false, + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "Zone in which to add the external firewall appliance.", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, + {}, { - "description": "URL of the traffic monitor Host", - "length": 255, - "name": "url", - "required": true, - "type": "string" + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" }, { - "description": "Traffic going into the listed zones will not be metered", - "length": 255, - "name": "excludezones", - "required": false, + "description": "the state of the account", + "name": "state", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, {}, { - "description": "the ID of the external firewall", - "name": "id", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" - } - ] - }, - { - "description": "Updates a project", - "isasync": true, - "name": "updateProject", - "params": [ - { - "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", - "length": 255, - "name": "swapowner", - "required": false, - "type": "boolean" }, { - "description": "display text of the project", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "id of the project to be modified", - "length": 255, - "name": "id", - "related": "activateProject,suspendProject,updateProject", - "required": true, - "type": "uuid" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "new Admin account for the project", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "ID of the user to be promoted/demoted", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers", - "required": false, - "type": "uuid" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "Account level role to be assigned to the user/account : Admin/Regular", - "length": 255, - "name": "roletype", - "required": false, + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "name of the project", - "length": 255, - "name": "name", - "required": false, - "since": "4.19.0", - "type": "string" - } - ], - "related": "activateProject,suspendProject", - "response": [ - { - "description": "the id of the project", - "name": "id", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, - {}, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the state of the project", - "name": "state", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of snapshots available for this project", + "description": "the total number of snapshots available for this account", "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", + "description": "the total number of virtual machines stopped for this account", "name": "vmstopped", "type": "integer" }, { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of backups available to this account", + "name": "backupavailable", + "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total number of virtual machines deployed by this project", + "description": "the total number of virtual machines deployed by this account", "name": "vmtotal", "type": "long" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" } - ], - "since": "3.0.0" + ] }, { - "description": "Lists internal load balancers", - "isasync": false, - "name": "listLoadBalancers", + "description": "Stops a router.", + "isasync": true, + "name": "stopRouter", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "forced", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the network ID of the source IP address", + "description": "the ID of the router", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, + "name": "id", + "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, "type": "uuid" - }, + } + ], + "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "response": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "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": "CPU arch of the router", + "name": "arch", + "type": "string" }, { - "description": "the scheme of the load balancer. Supported value is internal in the current release", - "length": 255, - "name": "scheme", - "required": false, + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the name of the load balancer", - "length": 255, - "name": "name", - "required": false, + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the Pod name for the router", + "name": "podname", + "type": "string" }, { - "description": "the network ID of the load balancer", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the template name for the router", + "name": "templatename", + "type": "string" }, { - "description": "the source IP address of the load balancer", - "length": 255, - "name": "sourceipaddress", - "required": false, + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the ID of the load balancer", - "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule", - "required": false, - "type": "uuid" + "description": "the template ID for the router", + "name": "templateid", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the second DNS for the router", + "name": "dns2", + "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" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - } - ], - "related": "createLoadBalancer", - "response": [ - {}, + "description": "the name of the router", + "name": "name", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host ID for the router", + "name": "hostid", + "type": "string" }, { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - }, - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - }, - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - } - ], - "type": "list" + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" }, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" }, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, - {}, { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", - "response": [ - { - "description": "the name of the instance", - "name": "name", - "type": "string" - }, - { - "description": "the state of the instance", - "name": "state", - "type": "string" - }, - { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the instance ID", - "name": "id", - "type": "string" - } - ], - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + {}, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "resource type", - "name": "resourcetype", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" } ], "type": "list" }, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the name of the Load Balancer", - "name": "name", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the Load Balancer ID", - "name": "id", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, + {}, { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the address", + "name": "project", "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Lists user accounts", - "isasync": false, - "name": "listUsers", - "params": [ - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List user by ID.", - "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers", - "required": false, - "type": "uuid" + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" }, { - "description": "List user by the username", - "length": 255, - "name": "username", - "required": false, + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", - "length": 255, - "name": "accounttype", - "required": false, - "type": "integer" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "flag to display the resource icon for users", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "description": "the domain ID associated with the router", + "name": "domainid", + "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" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "List users by state of the user account.", - "length": 255, - "name": "state", - "required": false, + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - } - ], - "related": "createUser,disableUser,enableUser,getUser", - "response": [ + }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" }, - {}, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + } + ], + "type": "set" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the user ID", - "name": "id", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" - }, + } + ] + }, + { + "description": "Deletes project invitation", + "isasync": true, + "name": "deleteProjectInvitation", + "params": [ { - "description": "the type of the role", - "name": "roletype", + "description": "id of the invitation", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "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 user state", - "name": "state", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {} + ], + "since": "3.0.0" + }, + { + "description": "create Tungsten-Fabric firewall policy", + "isasync": true, + "name": "createTungstenFabricFirewallPolicy", + "params": [ { - "description": "the account name of the user", - "name": "account", + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the sequence of Tungsten-Fabric firewall policy", + "length": 255, + "name": "sequence", + "required": true, + "type": "integer" }, - {}, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, + "description": "Tungsten-Fabric firewall policy name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + {}, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "Tungsten-Fabric firewall policy uuid", + "name": "uuid", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -94166,32 +92252,67 @@ var preCache = `{ "type": "integer" }, { - "description": "the user lastname", - "name": "lastname", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" - } + }, + { + "description": "Tungsten-Fabric firewall policy name", + "name": "name", + "type": "string" + }, + { + "description": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" + }, + {} ] }, { - "description": "This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user", + "description": "Updates a region", "isasync": false, - "name": "registerUserKeys", + "name": "updateRegion", "params": [ { - "description": "User id", + "description": "updates region with this name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "updates region with this end point", + "length": 255, + "name": "endpoint", + "required": false, + "type": "string" + }, + { + "description": "Id of region to update", "length": 255, "name": "id", - "related": "createUser,disableUser,enableUser,getUser", "required": true, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the end point of the region", + "name": "endpoint", + "type": "string" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" + }, + {}, + { + "description": "the name of the region", + "name": "name", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -94199,29 +92320,33 @@ var preCache = `{ "type": "string" }, { - "description": "the secret key of the registered user", - "name": "secretkey", - "type": "string" + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" }, {}, { - "description": "the api key of the registered user", - "name": "apikey", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {} + { + "description": "the ID of the region", + "name": "id", + "type": "integer" + } ] }, { - "description": "Deletes a load balancer stickiness policy.", + "description": "Deletes traffic type of a physical network", "isasync": true, - "name": "deleteLBStickinessPolicy", + "name": "deleteTrafficType", "params": [ { - "description": "the ID of the LB stickiness policy", + "description": "traffic type id", "length": 255, "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies", + "related": "addTrafficType,updateTrafficType", "required": true, "type": "uuid" } @@ -94233,261 +92358,257 @@ var preCache = `{ "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": "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" }, {} ], "since": "3.0.0" }, { - "description": "Updates a VLAN IP range.", - "isasync": false, - "name": "updateVlanIpRange", + "description": "Destroy a Shared FileSystem by id", + "isasync": true, + "name": "destroySharedFileSystem", "params": [ { - "description": "the netmask of the VLAN IP range", + "description": "the ID of the shared filesystem to delete", "length": 255, - "name": "netmask", + "name": "id", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if IP range is set to system vms, false if not", + "description": "If true is passed, the shared filesystem is expunged immediately. False by default.", "length": 255, - "name": "forsystemvms", + "name": "expunge", "required": false, "type": "boolean" }, { - "description": "the ending IP address in the VLAN IP range", - "length": 255, - "name": "endip", - "required": false, - "type": "string" - }, - { - "description": "the gateway of the VLAN IP range", + "description": "If true is passed, the shared filesystem can be destroyed without stopping it first.", "length": 255, - "name": "gateway", + "name": "forced", "required": false, - "type": "string" - }, + "type": "boolean" + } + ], + "response": [ { - "description": "the CIDR of IPv6 network, must be at least /64", - "length": 255, - "name": "ip6cidr", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", - "length": 255, - "name": "endipv6", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the UUID of the VLAN IP range", - "length": 255, - "name": "id", - "related": "updateVlanIpRange,dedicatePublicIpRange", - "required": true, - "type": "uuid" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the beginning IPv6 address in the IPv6 network range", - "length": 255, - "name": "startipv6", - "required": false, - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.20.0" + }, + { + "description": "Lists a project's project role permissions", + "isasync": false, + "name": "listProjectRolePermissions", + "params": [ { - "description": "the gateway of the IPv6 network", + "description": "ID of the project role", "length": 255, - "name": "ip6gateway", + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "ID of the project", "length": 255, - "name": "startip", - "required": false, - "type": "string" + "name": "projectid", + "related": "createProject", + "required": true, + "type": "uuid" } ], - "related": "dedicatePublicIpRange", + "related": "", "response": [ { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" - }, - {}, - { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the ID of the project", + "name": "projectid", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "the ID of the VLAN IP range", + "description": "the ID of the project role permission", "name": "id", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.15.0" + }, + { + "description": "Lists all LDAP configurations", + "isasync": false, + "name": "listLdapConfigurations", + "params": [ { - "description": "the domain name of the VLAN IP range", - "name": "domain", - "type": "string" + "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", + "length": 255, + "name": "listall", + "required": false, + "since": "4.13.2", + "type": "boolean" }, { - "description": "the domain ID of the VLAN IP range", + "description": "linked domain", + "length": 255, "name": "domainid", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the network id of vlan range", - "name": "networkid", - "type": "string" + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Port", + "length": 255, + "name": "port", + "required": false, "type": "integer" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" - }, - { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, - {}, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": false, "type": "string" - }, + } + ], + "related": "addLdapConfiguration", + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" + "description": "port the ldap server is running on", + "name": "port", + "type": "int" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, + {}, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "linked domain", + "name": "domainid", "type": "string" - } + }, + {} ], - "since": "4.16.0" + "since": "4.2.0" }, { - "description": "Lists site to site vpn connection gateways", - "isasync": false, - "name": "listVpnConnections", + "description": "Creates a l2tp/ipsec remote access vpn", + "isasync": true, + "name": "createRemoteAccessVpn", "params": [ { - "description": "id of vpc", + "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, "name": "fordisplay", "required": false, @@ -94495,1144 +92616,31582 @@ var preCache = `{ "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "public ip address id of the vpn server", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, + "name": "publicipid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, "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": "list resources by account. Must be used with the domainId parameter.", + "description": "an optional account for the VPN. Must be used with domainId.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "iprange", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", "length": 255, - "name": "listall", + "name": "openfirewall", "required": false, "type": "boolean" - }, - { - "description": "id of the vpn connection", - "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], - "related": "createVpnConnection", + "related": "listRemoteAccessVpns", "response": [ { - "description": "the owner", + "description": "the account of the remote access vpn", "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "the public IP address", + "description": "the public ip address of the vpn server", "name": "publicip", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - {}, - { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, - { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, - { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the project name", + "description": "the project name of the vpn", "name": "project", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", - "type": "string" - }, - { - "description": "the project id", - "name": "projectid", - "type": "string" - }, - { - "description": "is connection for display to the regular user", + "description": "is vpn for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the connection ID", + "description": "the id of the remote access vpn", "name": "id", "type": "string" }, + {}, + {}, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the public ip address of the vpn server", + "name": "publicipid", + "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" } ] }, { - "description": "Lists resource limits.", + "description": "(This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for this command to take effect.", "isasync": false, - "name": "listResourceLimits", + "name": "changeServiceForVirtualMachine", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "Type of resource. 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 an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", - "length": 255, - "name": "resourcetype", - "required": false, - "type": "integer" - }, - { - "description": "Lists resource limits by ID.", + "description": "New minimum number of IOPS for the custom disk offering", "length": 255, - "name": "id", + "name": "miniops", "required": false, + "since": "4.17", "type": "long" }, { - "description": "list only resources belonging to the domain specified", + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", "length": 255, - "name": "isrecursive", + "name": "automigrate", "required": false, + "since": "4.17", "type": "boolean" }, { - "description": "Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "The ID of the virtual machine", "length": 255, - "name": "resourcetypename", - "required": false, - "type": "string" + "name": "id", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" }, { - "description": "List by keyword", + "description": "New maximum number of IOPS for the custom disk offering", "length": 255, - "name": "keyword", + "name": "maxiops", "required": false, - "type": "string" + "since": "4.17", + "type": "long" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "Verify OK to Shrink", "length": 255, - "name": "listall", + "name": "shrinkok", "required": false, + "since": "4.17", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the service offering ID to apply to the virtual machine", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], - "related": "", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "response": [ + {}, { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the account of the resource limit", - "name": "account", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the domain name of the resource limit", - "name": "domain", + "description": "ssh key-pairs", + "name": "keypairs", "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": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the project id of the resource limit", - "name": "projectid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the project name of the resource limit", - "name": "project", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" - } - ] - }, - { - "description": "Disables a user account", - "isasync": true, - "name": "disableUser", - "params": [ + }, { - "description": "Disables user by user ID.", - "length": 255, + "description": "the ID of the virtual machine", "name": "id", - "related": "createUser,disableUser,enableUser,getUser", - "required": true, - "type": "uuid" - } - ], - "related": "createUser,enableUser,getUser", - "response": [ - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "type": "string" }, - {}, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the domain ID of the user", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "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 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 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" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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 domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "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" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "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 ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "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 project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "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 date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "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 ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + {}, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "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": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + } + ] + }, + { + "description": "Lists all available OS mappings for given hypervisor", + "isasync": false, + "name": "listGuestOsMapping", + "params": [ + { + "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", + "length": 255, + "name": "hypervisorversion", + "required": false, + "type": "string" + }, + { + "description": "list Guest OS mapping by hypervisor", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "list Guest OS mapping by OS display name", + "length": 255, + "name": "osdisplayname", + "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": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list mapping by its UUID", + "length": 255, + "name": "id", + "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", + "required": false, + "type": "uuid" + }, + { + "description": "list Guest OS mapping by OS mapping name with hypervisor", + "length": 255, + "name": "osnameforhypervisor", + "required": false, + "type": "string" + }, + { + "description": "list mapping by Guest OS Type UUID", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" + } + ], + "related": "addGuestOsMapping,updateGuestOsMapping", + "response": [ + { + "description": "standard display name for the Guest OS", + "name": "osdisplayname", + "type": "string" + }, + {}, + { + "description": "the ID of the Guest OS type", + "name": "ostypeid", + "type": "string" + }, + {}, + { + "description": "the ID of the Guest OS mapping", + "name": "id", + "type": "string" + }, + { + "description": "the hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", + "type": "string" + }, + { + "description": "is the mapping user defined", + "name": "isuserdefined", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.4.0" + }, + { + "description": "List all public, private, and privileged templates.", + "isasync": false, + "name": "listTemplates", + "params": [ + { + "description": "flag to display the resource image for the templates", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" + }, + { + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" + }, + { + "description": "ID of the storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.19", + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "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": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "length": 255, + "name": "isvnf", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "show removed templates as well", + "length": 255, + "name": "showremoved", + "required": false, + "type": "boolean" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "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 templates that can be used to deploy CKS clusters", + "length": 255, + "name": "forcks", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "ID of the extension for the template", + "length": 255, + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list datadisk templates by parent template id", + "length": 255, + "name": "parenttemplateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "ID of the image or image cache store", + "length": 255, + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": false, + "since": "4.19", + "type": "uuid" + }, + { + "description": "the IDs of the templates, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "since": "4.9", + "type": "list" + }, + { + "description": "the ID of the OS category for the template", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "length": 255, + "name": "templatefilter", + "required": true, + "type": "string" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the type of the template", + "length": 255, + "name": "templatetype", + "required": false, + "since": "4.19.0", + "type": "string" + }, + { + "description": "list templates that are ready to be deployed", + "length": 255, + "name": "isready", + "required": false, + "since": "4.21.0", + "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 template ID", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "the template name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "list templates by zoneId", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "If set to true, list only unique templates across zones", + "length": 255, + "name": "showunique", + "required": false, + "since": "4.13.2", + "type": "boolean" + }, + { + "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "length": 255, + "name": "details", + "required": false, + "since": "4.15", + "type": "list" + } + ], + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "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": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + {}, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "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 URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "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": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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 hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + {}, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + } + ] + }, + { + "description": "create Tungsten-Fabric policy", + "isasync": true, + "name": "createTungstenFabricPolicy", + "params": [ + { + "description": "Tungsten-Fabric policy name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "related": "listTungstenFabricPolicy", + "response": [ + { + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + {}, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + } + ] + }, + { + "description": "deletes a range of Autonomous Systems for BGP Dynamic Routing", + "isasync": false, + "name": "deleteASNRange", + "params": [ + { + "description": "ID of the AS range", + "length": 255, + "name": "id", + "related": "", + "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 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.20.0" + }, + { + "description": "Creates a bucket in the specified object storage pool. ", + "isasync": true, + "name": "createBucket", + "params": [ + { + "description": "The Bucket access policy", + "length": 255, + "name": "policy", + "required": false, + "type": "string" + }, + { + "description": "the domain ID associated with the bucket. If used with the account parameter returns the bucket associated with the account for the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Enable object locking in bucket", + "length": 255, + "name": "objectlocking", + "required": false, + "type": "boolean" + }, + { + "description": "Enable bucket encryption", + "length": 255, + "name": "encryption", + "required": false, + "type": "boolean" + }, + { + "description": "Id of the Object Storage Pool where bucket is created", + "length": 255, + "name": "objectstorageid", + "related": "addObjectStoragePool", + "required": true, + "type": "uuid" + }, + { + "description": "Enable bucket versioning", + "length": 255, + "name": "versioning", + "required": false, + "type": "boolean" + }, + { + "description": "Bucket Quota in GiB", + "length": 255, + "name": "quota", + "required": true, + "type": "integer" + }, + { + "description": "the account associated with the bucket. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the project associated with the bucket. Mutually exclusive with account parameter", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the bucket", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "listBuckets", + "response": [ + { + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" + }, + { + "description": "the date the Bucket was created", + "name": "created", + "type": "date" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account associated with the Bucket", + "name": "account", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name of the Bucket", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the domain associated with the bucket", + "name": "domainid", + "type": "string" + }, + { + "description": "Bucket Quota in GiB", + "name": "quota", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project id of the bucket", + "name": "projectid", + "type": "string" + }, + { + "description": "ID of the Bucket", + "name": "id", + "type": "string" + }, + { + "description": "Bucket Encryption", + "name": "encryption", + "type": "boolean" + }, + { + "description": "Bucket URL", + "name": "url", + "type": "string" + }, + { + "description": "the domain associated with the bucket", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the project name of the bucket", + "name": "project", + "type": "string" + }, + { + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", + "type": "string" + }, + { + "description": "Object storage provider", + "name": "provider", + "type": "string" + }, + { + "description": "Bucket Object Locking", + "name": "objectlocking", + "type": "boolean" + }, + { + "description": "State of the Bucket", + "name": "state", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", + "type": "string" + }, + { + "description": "Bucket Access Key", + "name": "accesskey", + "type": "string" + }, + {}, + { + "description": "Bucket Secret Key", + "name": "usersecretkey", + "type": "string" + }, + { + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" + }, + { + "description": "Bucket Access Policy", + "name": "policy", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Lists physical networks", + "isasync": false, + "name": "listPhysicalNetworks", + "params": [ + { + "description": "list physical network by id", + "length": 255, + "name": "id", + "related": "listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "search by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the Zone ID for the physical network", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "updatePhysicalNetwork", + "response": [ + { + "description": "the speed of the physical network", + "name": "networkspeed", + "type": "string" + }, + { + "description": "comma separated tag", + "name": "tags", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the domain id of the physical network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "isolation methods", + "name": "isolationmethods", + "type": "string" + }, + { + "description": "state of the physical network", + "name": "state", + "type": "string" + }, + { + "description": "zone name of the physical network", + "name": "zonename", + "type": "string" + }, + { + "description": "name of the physical network", + "name": "name", + "type": "string" + }, + { + "description": "the vlan of the physical network", + "name": "vlan", + "type": "string" + }, + { + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", + "type": "string" + }, + { + "description": "zone id of the physical network", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the uuid of the physical network", + "name": "id", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists all firewall rules for an IP address.", + "isasync": false, + "name": "listFirewallRules", + "params": [ + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "list firewall rules for certain network", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "since": "4.3", + "type": "uuid" + }, + { + "description": "the ID of IP address of the firewall services", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "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 resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "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" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "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": "Lists rule with the specified ID.", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "createFirewallRule,updateEgressFirewallRule", + "response": [ + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + {}, + { + "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": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": " delete a Brocade VCS Switch", + "isasync": true, + "name": "deleteBrocadeVcsDevice", + "params": [ + { + "description": "Brocade Switch ID", + "length": 255, + "name": "vcsdeviceid", + "related": "", + "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": "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": "Extracts an ISO", + "isasync": true, + "name": "extractIso", + "params": [ + { + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, + "type": "string" + }, + { + "description": "the ID of the ISO file", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,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 where the ISO is originally located", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the URL to which the ISO would be extracted", + "length": 2048, + "name": "url", + "required": false, + "type": "string" + } + ], + "related": "downloadImageStoreObject,extractSnapshot,extractTemplate", + "response": [ + { + "description": "the name of the extracted object", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" + }, + { + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", + "type": "string" + }, + {}, + { + "description": "zone name the object was extracted from", + "name": "zonename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the upload id of extracted object", + "name": "extractId", + "type": "string" + }, + { + "description": "the status of the extraction", + "name": "status", + "type": "string" + }, + { + "description": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" + }, + { + "description": "the id of extracted object", + "name": "id", + "type": "string" + }, + { + "description": "", + "name": "resultstring", + "type": "string" + }, + { + "description": "the time and date the object was created", + "name": "created", + "type": "date" + }, + { + "description": "the state of the extracted object", + "name": "state", + "type": "string" + }, + { + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" + }, + { + "description": "the account id to which the extracted object belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "type of the storage", + "name": "storagetype", + "type": "string" + } + ] + }, + { + "description": "Lists all Routing firewall rules", + "isasync": false, + "name": "listRoutingFirewallRules", + "params": [ + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "type": "boolean" + }, + { + "description": "list Routing firewall rules by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "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 by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "Lists Routing firewall rule with the specified ID", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "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": "list Routing firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "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": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "response": [ + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + {}, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "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 state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" + } + ], + "since": "4.20.0" + }, + { + "description": "Creates an affinity/anti-affinity group", + "isasync": true, + "name": "createAffinityGroup", + "params": [ + { + "description": "an account for the affinity group. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Type of the affinity group from the available affinity/anti-affinity group types", + "length": 255, + "name": "type", + "required": true, + "type": "string" + }, + { + "description": "name of the affinity group", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "create affinity group for project", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "domainId of the account owning the affinity group", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "optional description of the affinity group", + "length": 255, + "name": "description", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "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 domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ] + }, + { + "description": "Logs a user into the CloudStack after successful verification of OAuth secret code from the particular provider.A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the \"logout\" command has been issued or the session has expired.", + "isasync": false, + "name": "oauthlogin", + "params": [ + { + "description": "Name of the provider", + "length": 255, + "name": "provider", + "required": true, + "type": "string" + }, + { + "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", + "length": 255, + "name": "domainId", + "required": false, + "type": "long" + }, + { + "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "length": 255, + "name": "domain", + "required": false, + "type": "string" + }, + { + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "length": 255, + "name": "secretcode", + "required": false, + "type": "string" + }, + { + "description": "Email id with which user tried to login using OAuth provider", + "length": 255, + "name": "email", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "User ID", + "name": "userid", + "type": "string" + }, + { + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", + "type": "string" + }, + { + "description": "the account name the user belongs to", + "name": "account", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Domain ID that the user belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "Is two factor authentication enabled", + "name": "is2faenabled", + "type": "string" + }, + { + "description": "Is two factor authentication verified", + "name": "is2faverified", + "type": "string" + }, + { + "description": "Is user registered", + "name": "registered", + "type": "string" + }, + { + "description": "first name of the user", + "name": "firstname", + "type": "string" + }, + { + "description": "Management Server ID that the user logged to", + "name": "managementserverid", + "type": "string" + }, + { + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", + "type": "string" + }, + { + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", + "type": "string" + }, + { + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" + }, + {}, + { + "description": "Username", + "name": "username", + "type": "string" + }, + { + "description": "Two factor authentication provider", + "name": "providerfor2fa", + "type": "string" + }, + { + "description": "user time zoneoffset", + "name": "timezoneoffset", + "type": "string" + }, + { + "description": "last name of the user", + "name": "lastname", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "user time zone", + "name": "timezone", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Lists all available Internal Load Balancer elements.", + "isasync": false, + "name": "listInternalLoadBalancerElements", + "params": [ + { + "description": "list internal load balancer elements by id", + "length": 255, + "name": "id", + "related": "listInternalLoadBalancerElements", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list internal load balancer elements by enabled state", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list internal load balancer elements by network service provider id", + "length": 255, + "name": "nspid", + "related": "addNetworkServiceProvider,listTrafficTypes", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the id of the internal load balancer element", + "name": "id", + "type": "string" + }, + { + "description": "the physical network service provider id of the element", + "name": "nspid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ], + "since": "4.2.0" + }, + { + "description": "Gets the guest OS names in the hypervisor", + "isasync": true, + "name": "getHypervisorGuestOsNames", + "params": [ + { + "description": "Hypervisor version to get the guest os names (atleast one hypervisor host with the version specified must be available)", + "length": 255, + "name": "hypervisorversion", + "required": true, + "type": "string" + }, + { + "description": "Keyword for guest os name", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "Hypervisor type. One of : VMware, XenServer", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the hypervisor", + "name": "hypervisor", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the guest OS count of the hypervisor", + "name": "guestoscount", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the guest OS list of the hypervisor", + "name": "guestoslist", + "response": [ + { + "description": "standard display name for the Guest OS", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "version of the hypervisor for guest os names", + "name": "hypervisorversion", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Create Tungsten-Fabric provider in cloudstack", + "isasync": false, + "name": "createTungstenFabricProvider", + "params": [ + { + "description": "Tungsten-Fabric provider introspect port", + "length": 255, + "name": "tungstenproviderintrospectport", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric provider port", + "length": 255, + "name": "tungstenproviderport", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric provider hostname", + "length": 255, + "name": "tungstenproviderhostname", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric provider name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric provider vrouter port", + "length": 255, + "name": "tungstenprovidervrouterport", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric provider gateway", + "length": 255, + "name": "tungstengateway", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "related": "", + "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": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric provider name", + "name": "name", + "type": "string" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", + "type": "string" + }, + {} + ] + }, + { + "description": "Reboots a virtual machine.", + "isasync": true, + "name": "rebootVirtualMachine", + "params": [ + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "Force reboot the VM (VM is Stopped and then Started)", + "length": 255, + "name": "forced", + "required": false, + "since": "4.16.0", + "type": "boolean" + }, + { + "description": "Boot into hardware setup menu or not", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" + } + ], + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "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 nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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" + } + ], + "type": "set" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "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": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + {}, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "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 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": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + {}, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "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 hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "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 amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "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 description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + {}, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + } + ] + }, + { + "description": "Enables HA cluster-wide", + "isasync": true, + "name": "enableHAForCluster", + "params": [ + { + "description": "ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "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": "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" + } + ], + "since": "4.11" + }, + { + "description": "Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", + "isasync": false, + "name": "addVirtualMachinesToKubernetesCluster", + "params": [ + { + "description": "Is control node or not? Defaults to false.", + "length": 255, + "name": "iscontrolnode", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", + "required": true, + "type": "uuid" + }, + { + "description": "the IDs of the VMs to add to the cluster", + "length": 255, + "name": "virtualmachineids", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "list" + } + ], + "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" + }, + {} + ], + "since": "4.19.0" + }, + { + "description": "list Tungsten-Fabric logical router", + "isasync": false, + "name": "listTungstenFabricLogicalRouter", + "params": [ + { + "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 network", + "length": 255, + "name": "networkuuid", + "required": false, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric logical router", + "length": 255, + "name": "logicalrouteruuid", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "createTungstenFabricLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", + "response": [ + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric logical router name", + "name": "name", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + } + ] + }, + { + "description": "Lists backup offerings", + "isasync": false, + "name": "listBackupOfferings", + "params": [ + { + "description": "The zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "The backup offering ID", + "length": 255, + "name": "id", + "related": "listBackupOfferings,updateBackupOffering", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "updateBackupOffering", + "response": [ + { + "description": "whether offering allows user driven ad-hoc/scheduled backups", + "name": "allowuserdrivenbackups", + "type": "boolean" + }, + { + "description": "external ID on the provider side", + "name": "externalid", + "type": "string" + }, + { + "description": "the date this backup offering was created", + "name": "created", + "type": "date" + }, + { + "description": "zone ID", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "description for the backup offering", + "name": "description", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name for the backup offering", + "name": "name", + "type": "string" + }, + {}, + { + "description": "ID of the backup offering", + "name": "id", + "type": "string" + }, + { + "description": "provider name", + "name": "provider", + "type": "string" + }, + { + "description": "zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "Lists all available GPU cards", + "isasync": false, + "name": "listGpuCards", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "device name of the GPU card", + "length": 255, + "name": "devicename", + "required": false, + "type": "string" + }, + { + "description": "If true, only GPU cards which have a device will be listed. If false, all GPU cards will be listed.", + "length": 255, + "name": "activeonly", + "required": false, + "type": "boolean" + }, + { + "description": "device ID of the GPU card", + "length": 255, + "name": "deviceid", + "required": false, + "type": "string" + }, + { + "description": "ID of the GPU card", + "length": 255, + "name": "id", + "related": "listGpuCards", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "vendor ID of the GPU card", + "length": 255, + "name": "vendorid", + "required": false, + "type": "string" + }, + { + "description": "vendor name of the GPU card", + "length": 255, + "name": "vendorname", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the device ID of the GPU card", + "name": "deviceid", + "type": "string" + }, + { + "description": "the device name of the GPU card", + "name": "devicename", + "type": "string" + }, + { + "description": "the display name of the GPU card", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the vendor name of the GPU card", + "name": "vendorname", + "type": "string" + }, + {}, + { + "description": "the ID of the GPU card", + "name": "id", + "type": "string" + }, + { + "description": "the vendor ID of the GPU card", + "name": "vendorid", + "type": "string" + } + ], + "since": "4.21.0" + }, + { + "description": "Adds a guest OS name to hypervisor OS name mapping", + "isasync": true, + "name": "addGuestOsMapping", + "params": [ + { + "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" + }, + { + "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", + "length": 255, + "name": "osmappingcheckenabled", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "OS name specific to the hypervisor", + "length": 255, + "name": "osnameforhypervisor", + "required": true, + "type": "string" + }, + { + "description": "Forces add user defined guest os mapping, overrides any existing user defined mapping", + "length": 255, + "name": "forced", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", + "length": 255, + "name": "hypervisorversion", + "required": true, + "type": "string" + }, + { + "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", + "length": 255, + "name": "osdisplayname", + "required": false, + "type": "string" + }, + { + "description": "Hypervisor type. One of : XenServer, KVM, VMWare", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + } + ], + "related": "updateGuestOsMapping", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "standard display name for the Guest OS", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "the ID of the Guest OS type", + "name": "ostypeid", + "type": "string" + }, + { + "description": "is the mapping user defined", + "name": "isuserdefined", + "type": "string" + }, + { + "description": "the ID of the Guest OS mapping", + "name": "id", + "type": "string" + }, + { + "description": "the hypervisor", + "name": "hypervisor", + "type": "string" + } + ], + "since": "4.4.0" + }, + { + "description": "List all public, private, and privileged VNF templates.", + "isasync": false, + "name": "listVnfTemplates", + "params": [ + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" + }, + { + "description": "ID of the extension for the template", + "length": 255, + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "list datadisk templates by parent template id", + "length": 255, + "name": "parenttemplateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "If set to true, list only unique templates across zones", + "length": 255, + "name": "showunique", + "required": false, + "since": "4.13.2", + "type": "boolean" + }, + { + "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "length": 255, + "name": "details", + "required": false, + "since": "4.15", + "type": "list" + }, + { + "description": "list templates that can be used to deploy CKS clusters", + "length": 255, + "name": "forcks", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "the template ID", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the OS category for the template", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "length": 255, + "name": "templatefilter", + "required": true, + "type": "string" + }, + { + "description": "flag to display the resource image for the templates", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" + }, + { + "description": "the IDs of the templates, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "since": "4.9", + "type": "list" + }, + { + "description": "the type of the template", + "length": 255, + "name": "templatetype", + "required": false, + "since": "4.19.0", + "type": "string" + }, + { + "description": "show removed templates as well", + "length": 255, + "name": "showremoved", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "length": 255, + "name": "isvnf", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "list templates by zoneId", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the template name", + "length": 255, + "name": "name", + "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" + }, + { + "description": "list templates that are ready to be deployed", + "length": 255, + "name": "isready", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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 id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + {}, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "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": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + {}, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "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 secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "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 processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.", + "isasync": true, + "name": "deployVnfAppliance", + "params": [ + { + "description": "availability zone for the virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", + "length": 255, + "name": "iptonetworklist", + "required": false, + "type": "map" + }, + { + "description": "the mac address for default vm's network", + "length": 255, + "name": "macaddress", + "required": false, + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "length": 255, + "name": "dhcpoptionsnetworklist", + "required": false, + "type": "map" + }, + { + "description": "", + "length": 255, + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "since": "4.21", + "type": "uuid" + }, + { + "description": "the ipv6 address for default vm's network", + "length": 255, + "name": "ip6address", + "required": false, + "type": "string" + }, + { + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "length": 255, + "name": "details", + "required": false, + "since": "4.3", + "type": "map" + }, + { + "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "length": 255, + "name": "boottype", + "required": false, + "since": "4.14.0.0", + "type": "string" + }, + { + "description": "Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200", + "length": 255, + "name": "datadisksdetails", + "required": false, + "since": "4.21.0", + "type": "map" + }, + { + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, + "name": "displayvm", + "required": false, + "since": "4.2", + "type": "boolean" + }, + { + "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "length": 255, + "name": "copyimagetags", + "required": false, + "since": "4.13", + "type": "boolean" + }, + { + "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "length": 255, + "name": "keyboard", + "required": false, + "type": "string" + }, + { + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", + "required": false, + "since": "4.12", + "type": "string" + }, + { + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18", + "type": "map" + }, + { + "description": "Number of days instance is leased for.", + "length": 255, + "name": "leaseduration", + "required": false, + "since": "4.21.0", + "type": "integer" + }, + { + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "length": 255, + "name": "size", + "required": false, + "type": "long" + }, + { + "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", + "length": 255, + "name": "nicnetworklist", + "required": false, + "since": "4.15", + "type": "map" + }, + { + "description": "used to specify the vApp properties.", + "length": 255, + "name": "properties", + "required": false, + "since": "4.15", + "type": "map" + }, + { + "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, + "type": "string" + }, + { + "description": "an optional group for the virtual machine", + "length": 255, + "name": "group", + "required": false, + "type": "string" + }, + { + "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "length": 255, + "name": "rootdisksize", + "required": false, + "since": "4.4", + "type": "long" + }, + { + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "length": 255, + "name": "affinitygroupids", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0.", + "length": 255, + "name": "vnfcidrlist", + "required": false, + "type": "list" + }, + { + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" + }, + { + "description": "Lease expiry action, valid values are STOP and DESTROY", + "length": 255, + "name": "leaseexpiryaction", + "required": false, + "since": "4.21.0", + "type": "string" + }, + { + "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", + "length": 255, + "name": "iothreadsenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the ip address for default vm's network", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, + { + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "True by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. False otherwise. Network rules are configured if management network is an isolated network or shared network with security groups.", + "length": 255, + "name": "vnfconfiguremanagement", + "required": false, + "type": "boolean" + }, + { + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "type": "string" + }, + { + "description": "Controls specific policies on IO", + "length": 255, + "name": "iodriverpolicy", + "required": false, + "type": "string" + }, + { + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "length": 255, + "name": "affinitygroupnames", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "name of the ssh key pair used to login to the virtual machine", + "length": 255, + "name": "keypair", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "snapshotid", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "required": false, + "since": "4.21", + "type": "uuid" + }, + { + "description": "true if start vm after creating; defaulted to true if not specified", + "length": 255, + "name": "startvm", + "required": false, + "type": "boolean" + }, + { + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "length": 255, + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "list" + }, + { + "description": "The number of queues for multiqueue NICs.", + "length": 255, + "name": "nicmultiqueuenumber", + "required": false, + "since": "4.18", + "type": "integer" + }, + { + "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", + "length": 255, + "name": "overridediskofferingid", + "related": "", + "required": false, + "since": "4.17", + "type": "uuid" + }, + { + "description": "the ID of the Userdata", + "length": 255, + "name": "userdataid", + "related": "listCniConfiguration", + "required": false, + "since": "4.18", + "type": "uuid" + }, + { + "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "host name for the virtual machine", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "length": 255, + "name": "securitygroupnames", + "related": "updateSecurityGroup", + "required": false, + "type": "list" + }, + { + "description": "an optional user generated name for the virtual machine", + "length": 255, + "name": "displayname", + "required": false, + "type": "string" + }, + { + "description": "true if virtual machine needs to be dynamically scalable", + "length": 255, + "name": "dynamicscalingenabled", + "required": false, + "since": "4.16", + "type": "boolean" + }, + { + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "length": 255, + "name": "deploymentplanner", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "length": 255, + "name": "password", + "required": false, + "since": "4.19.0.0", + "type": "string" + }, + { + "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "length": 255, + "name": "securitygroupids", + "related": "updateSecurityGroup", + "required": false, + "type": "list" + }, + { + "description": "the ID of the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", + "length": 255, + "name": "datadiskofferinglist", + "required": false, + "since": "4.11", + "type": "map" + }, + { + "description": "Enable packed virtqueues or not.", + "length": 255, + "name": "nicpackedvirtqueuesenabled", + "required": false, + "since": "4.18", + "type": "boolean" + }, + { + "description": "names of the ssh key pairs used to login to the virtual machine", + "length": 255, + "name": "keypairs", + "required": false, + "since": "4.17", + "type": "list" + }, + { + "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "length": 255, + "name": "bootmode", + "required": false, + "since": "4.14.0.0", + "type": "string" + }, + { + "description": "Deploy vm for the project", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", + "length": 255, + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" + }, + { + "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" + } + ], + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ + { + "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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "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": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "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": "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the name of the security group", + "name": "name", + "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 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": "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" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the 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": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "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": "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 type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + {}, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + } + ], + "since": "4.19.0" + }, + { + "description": "Updates a network offering.", + "isasync": false, + "name": "updateNetworkOffering", + "params": [ + { + "description": "the availability of network offering. The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required ", + "length": 255, + "name": "availability", + "required": false, + "type": "string" + }, + { + "description": "the display text of the network offering", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "maximum number of concurrent connections supported by the network offering", + "length": 255, + "name": "maxconnections", + "required": false, + "type": "integer" + }, + { + "description": "the id of the network offering", + "length": 255, + "name": "id", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "required": false, + "type": "uuid" + }, + { + "description": "update state for the network offering", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "sort key of the network offering, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "the name of the network offering", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "length": 255, + "name": "keepaliveenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", + "required": false, + "type": "string" + }, + { + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "length": 4096, + "name": "zoneid", + "required": false, + "since": "4.13", + "type": "string" + }, + { + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 255, + "name": "domainid", + "required": false, + "type": "string" + } + ], + "related": "createNetworkOffering,listNetworkOfferings", + "response": [ + { + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", + "type": "boolean" + }, + { + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" + }, + { + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", + "type": "string" + }, + { + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" + }, + { + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" + }, + { + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" + }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "the internet protocol of the network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "availability of the network offering", + "name": "availability", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "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 network offering was created", + "name": "created", + "type": "date" + }, + { + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "type": "string" + }, + { + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" + }, + { + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "the tags for the network offering", + "name": "tags", + "type": "string" + }, + { + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", + "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 domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" + }, + { + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" + }, + { + "description": "the id of the network offering", + "name": "id", + "type": "string" + }, + { + "description": "the name of the network offering", + "name": "name", + "type": "string" + }, + { + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", + "type": "string" + } + ] + }, + { + "description": "Changes out-of-band management interface password on the host and updates the interface configuration in CloudStack if the operation succeeds, else reverts the old password", + "isasync": true, + "name": "changeOutOfBandManagementPassword", + "params": [ + { + "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", + "length": 255, + "name": "password", + "required": false, + "type": "string" + }, + { + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost", + "response": [ + { + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" + }, + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + { + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" + }, + { + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the operation result description", + "name": "description", + "type": "string" + }, + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + {}, + { + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" + }, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "List resource detail(s)", + "isasync": false, + "name": "listResourceDetails", + "params": [ + { + "description": "list by key, value. Needs to be passed only along with key", + "length": 255, + "name": "value", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "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 resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "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": "list by resource id", + "length": 255, + "name": "resourceid", + "required": false, + "type": "string" + }, + { + "description": "list by key", + "length": 255, + "name": "key", + "required": false, + "type": "string" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "list by resource type", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "if set to true, only details marked with display=true, are returned. False by default", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.3", + "type": "boolean" + } + ], + "related": "", + "response": [ + { + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.2" + }, + { + "description": "Dedicate an existing cluster", + "isasync": true, + "name": "dedicateCluster", + "params": [ + { + "description": "the ID of the Cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "listDedicatedClusters", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the cluster", + "name": "clustername", + "type": "string" + }, + { + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", + "type": "string" + }, + { + "description": "the ID of the cluster", + "name": "clusterid", + "type": "string" + }, + { + "description": "the domain ID of the cluster", + "name": "domainid", + "type": "string" + }, + { + "description": "the Account ID of the cluster", + "name": "accountid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" + }, + {} + ] + }, + { + "description": "Creates a network offering.", + "isasync": false, + "name": "createNetworkOffering", + "params": [ + { + "description": "true if the network offering is IP conserve mode enabled", + "length": 255, + "name": "conservemode", + "required": false, + "type": "boolean" + }, + { + "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": "true if network offering is meant to be used for VPC, false otherwise.", + "length": 255, + "name": "forvpc", + "required": false, + "type": "boolean" + }, + { + "description": "the name of the network offering", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "guest type of the network offering: Shared or Isolated", + "length": 255, + "name": "guestiptype", + "required": true, + "type": "string" + }, + { + "description": "the traffic type for the network offering. Supported type in current release is GUEST only", + "length": 255, + "name": "traffictype", + "required": true, + "type": "string" + }, + { + "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", + "length": 255, + "name": "internetprotocol", + "required": false, + "since": "4.17.0", + "type": "string" + }, + { + "description": "the ID of the containing zone(s), null for public offerings", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "since": "4.13", + "type": "list" + }, + { + "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", + "length": 255, + "name": "fortungsten", + "required": false, + "type": "boolean" + }, + { + "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", + "length": 255, + "name": "networkmode", + "required": false, + "since": "4.20.0", + "type": "string" + }, + { + "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", + "length": 255, + "name": "routingmode", + "required": false, + "since": "4.20.0", + "type": "string" + }, + { + "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "length": 255, + "name": "keepaliveenabled", + "required": false, + "type": "boolean" + }, + { + "description": "data transfer rate in megabits per second allowed", + "length": 255, + "name": "networkrate", + "required": false, + "type": "integer" + }, + { + "description": "true if network offering supports vlans", + "length": 255, + "name": "specifyvlan", + "required": false, + "type": "boolean" + }, + { + "description": "true if network offering supports choosing AS number", + "length": 255, + "name": "specifyasnumber", + "required": false, + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", + "length": 255, + "name": "details", + "required": false, + "since": "4.2.0", + "type": "map" + }, + { + "description": "Name of the provider providing the service", + "length": 255, + "name": "provider", + "required": false, + "since": "4.21.0", + "type": "string" + }, + { + "description": "desired service capabilities as part of network offering", + "length": 255, + "name": "servicecapabilitylist", + "required": false, + "type": "map" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "length": 255, + "name": "egressdefaultpolicy", + "required": false, + "type": "boolean" + }, + { + "description": "true if network offering for NSX network offering supports Internal Load balancer service.", + "length": 255, + "name": "nsxsupportsinternallb", + "required": false, + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", + "length": 255, + "name": "serviceproviderlist", + "required": false, + "type": "map" + }, + { + "description": "the availability of network offering. The default value is Optional. Another value is Required, which will make it as the default network offering for new networks ", + "length": 255, + "name": "availability", + "required": false, + "type": "string" + }, + { + "description": "maximum number of concurrent connections supported by the network offering", + "length": 255, + "name": "maxconnections", + "required": false, + "type": "integer" + }, + { + "description": "the display text of the network offering, defaults to the value of 'name'.", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", + "length": 255, + "name": "specifyipranges", + "required": false, + "type": "boolean" + }, + { + "description": "true if network offering is meant to be used for NSX, false otherwise.", + "length": 255, + "name": "fornsx", + "required": false, + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "length": 255, + "name": "ispersistent", + "required": false, + "type": "boolean" + }, + { + "description": "services supported by the network offering", + "length": 255, + "name": "supportedservices", + "required": false, + "type": "list" + }, + { + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", + "required": false, + "type": "string" + }, + { + "description": "the ID of the containing domain(s), null for public offerings", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "list" + }, + { + "description": "true if network offering for NSX network offering supports Load balancer service.", + "length": 255, + "name": "nsxsupportlb", + "required": false, + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "the service offering ID used by virtual router provider", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" + } + ], + "related": "listNetworkOfferings", + "response": [ + { + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "type": "string" + }, + { + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", + "type": "boolean" + }, + { + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" + }, + { + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" + }, + { + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" + }, + { + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" + }, + { + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "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 service name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" + }, + { + "description": "the internet protocol of the network offering", + "name": "internetprotocol", + "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": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" + }, + { + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the network offering", + "name": "name", + "type": "string" + }, + { + "description": "the tags for the network offering", + "name": "tags", + "type": "string" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "availability of the network offering", + "name": "availability", + "type": "string" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" + }, + { + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" + }, + { + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "the id of the network offering", + "name": "id", + "type": "string" + }, + { + "description": "the date this network offering was created", + "name": "created", + "type": "date" + }, + { + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" + }, + { + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Creates an IP forwarding rule", + "isasync": true, + "name": "createIpForwardingRule", + "params": [ + { + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", + "length": 255, + "name": "openfirewall", + "required": false, + "type": "boolean" + }, + { + "description": "the public IP address ID of the forwarding rule, already associated via associateIp", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + }, + { + "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "the end port for the rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "the protocol for the rule. Valid values are TCP or UDP.", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" + }, + { + "description": "the start port for the rule", + "length": 255, + "name": "startport", + "required": true, + "type": "integer" + } + ], + "related": "createPortForwardingRule,updatePortForwardingRule", + "response": [ + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + {}, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + {}, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + } + ] + }, + { + "description": "Lists the network Interfaces of elastistor", + "isasync": false, + "name": "listElastistorInterface", + "params": [ + { + "description": "controller id", + "length": 255, + "name": "controllerid", + "required": false, + "type": "string" + } + ], + "related": "listElastistorVolume", + "response": [ + { + "description": "synchronization", + "name": "sync", + "type": "string" + }, + { + "description": "compression", + "name": "compression", + "type": "string" + }, + {}, + { + "description": "the name of the volume", + "name": "name", + "type": "string" + }, + { + "description": "graceallowed", + "name": "graceallowed", + "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": "the id of the volume", + "name": "id", + "type": "string" + }, + { + "description": "deduplication", + "name": "deduplication", + "type": "string" + } + ] + }, + { + "description": "Updates load balancer stickiness policy", + "isasync": true, + "name": "updateLBStickinessPolicy", + "params": [ + { + "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": "id of lb stickiness policy", + "length": 255, + "name": "id", + "related": "createLBStickinessPolicy,updateLBStickinessPolicy", + "required": true, + "type": "uuid" + }, + { + "description": "an optional field, whether to the display the policy to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + } + ], + "related": "createLBStickinessPolicy", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the account of the Stickiness policy", + "name": "account", + "type": "string" + }, + { + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", + "response": [ + { + "description": "the method name of the Stickiness policy", + "name": "methodname", + "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the LB Stickiness policy ID", + "name": "id", + "type": "string" + }, + { + "description": "the params of the policy", + "name": "params", + "type": "map" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the domain of the Stickiness policy", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, + {}, + { + "description": "the domain ID of the Stickiness policy", + "name": "domainid", + "type": "string" + }, + { + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" + }, + {} + ], + "since": "4.4" + }, + { + "description": "Lists all Pods.", + "isasync": false, + "name": "listPods", + "params": [ + { + "description": "the name of the storage access group", + "length": 255, + "name": "storageaccessgroup", + "required": false, + "since": "4.21.0", + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list Pods by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "list pods by allocation state", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "flag to display the capacity of the pods", + "length": 255, + "name": "showcapacities", + "required": false, + "type": "boolean" + }, + { + "description": "list Pods by ID", + "length": 255, + "name": "id", + "related": "listPods,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "list Pods by Zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "createManagementNetworkIpRange", + "response": [ + { + "description": "the ID of the Pod", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of the Pod", + "name": "gateway", + "type": "string" + }, + {}, + { + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" + }, + { + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" + }, + { + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the Pod", + "name": "name", + "type": "string" + }, + { + "description": "the capacity of the Pod", + "name": "capacity", + "response": [ + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + } + ], + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + { + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" + }, + { + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + }, + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + }, + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "the ending IP for the range", + "name": "endip", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", + "type": "string" + }, + {} + ] + }, + { + "description": "delete Tungsten-Fabric address group", + "isasync": true, + "name": "deleteTungstenFabricAddressGroup", + "params": [ + { + "description": "the uuid of Tungsten-Fabric address group", + "length": 255, + "name": "addressgroupuuid", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "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": "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": "Stops a running CloudManaged Kubernetes cluster", + "isasync": true, + "name": "stopKubernetesCluster", + "params": [ + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", + "required": true, + "type": "uuid" + } + ], + "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": "Deletes a vGPU profile from the system", + "isasync": false, + "name": "deleteVgpuProfile", + "params": [ + { + "description": "the ID of the vGPU profile", + "length": 255, + "name": "id", + "related": "createVgpuProfile", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "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" + }, + {} + ], + "since": "4.21.0" + }, + { + "description": "Delete the extensions", + "isasync": false, + "name": "deleteExtension", + "params": [ + { + "description": "ID of the extension", + "length": 255, + "name": "id", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", + "required": false, + "type": "uuid" + }, + { + "description": "Whether cleanup entry-point files for the extension", + "length": 255, + "name": "cleanup", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", + "required": false, + "type": "boolean" + } + ], + "related": "listExtensions,updateExtension,unregisterExtension", + "response": [ + { + "description": "ID of the extension", + "name": "id", + "type": "string" + }, + {}, + { + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" + }, + { + "description": "Type of the extension", + "name": "type", + "type": "string" + }, + { + "description": "Description of the extension", + "name": "description", + "type": "string" + }, + { + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" + }, + {}, + {}, + { + "description": "Name of the extension", + "name": "name", + "type": "string" + }, + { + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" + }, + { + "description": "The details of the extension", + "name": "details", + "type": "map" + }, + { + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" + }, + { + "description": "The path of the entry point fo the extension", + "name": "path", + "type": "string" + }, + { + "description": "List of resources to which extension is registered to", + "name": "resources", + "response": [ + { + "description": "Type of the resource", + "name": "type", + "type": "string" + }, + { + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" + }, + { + "description": "ID of the resource associated with the extension", + "name": "id", + "type": "string" + }, + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "type": "string" + }, + { + "description": "the details of the resource map", + "name": "details", + "type": "map" + } + ], + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The state of the extension", + "name": "state", + "type": "string" + } + ], + "since": "4.21.0" + }, + { + "description": "Adds account to a project", + "isasync": true, + "name": "addAccountToProject", + "params": [ + { + "description": "ID of the project to add the account to", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": true, + "type": "uuid" + }, + { + "description": "name of the account to be added to the project", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", + "length": 255, + "name": "roletype", + "required": false, + "type": "string" + }, + { + "description": "email to which invitation to the project is going to be sent", + "length": 255, + "name": "email", + "required": false, + "type": "string" + }, + { + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, + "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": "3.0.0" + }, + { + "description": "Lists all available snapshots for the account.", + "isasync": false, + "name": "listSnapshots", + "params": [ + { + "description": "ID of the storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.19", + "type": "uuid" + }, + { + "description": "list snapshots by zone id", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "ID of the image or image cache store", + "length": 255, + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": false, + "since": "4.19", + "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": "the IDs of the snapshots, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "required": false, + "since": "4.9", + "type": "list" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "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": "the ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", + "length": 255, + "name": "intervaltype", + "required": false, + "type": "string" + }, + { + "description": "If set to false, list templates across zones and their storages", + "length": 255, + "name": "showunique", + "required": false, + "since": "4.19.0", + "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": "lists snapshot by snapshot ID", + "length": 255, + "name": "id", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "required": false, + "type": "uuid" + }, + { + "description": "valid values are MANUAL or RECURRING.", + "length": 255, + "name": "snapshottype", + "required": false, + "type": "string" + }, + { + "description": "lists snapshot by snapshot name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", + "length": 255, + "name": "locationtype", + "required": false, + "since": "4.19.0", + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", + "response": [ + { + "description": "the project name of the snapshot", + "name": "project", + "type": "string" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + { + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "volumename", + "type": "string" + }, + { + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" + }, + {}, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + {}, + { + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" + }, + { + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" + }, + { + "description": "ID of the snapshot", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" + }, + { + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" + }, + { + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", + "type": "long" + }, + { + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + { + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "id of the availability zone", + "name": "zoneid", + "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": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" + }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, + { + "description": "name of the snapshot", + "name": "name", + "type": "string" + }, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" + }, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + } + ] + }, + { + "description": "Lists IPv4 subnets for zone.", + "isasync": false, + "name": "listIpv4SubnetsForZone", + "params": [ + { + "description": "project who which the IPv4 subnet is dedicated to", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "UUID of the IPv4 subnet.", + "length": 255, + "name": "id", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "required": false, + "type": "uuid" + }, + { + "description": "the domain ID which the IPv4 subnet is dedicated to.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "UUID of zone to which the IPv4 subnet belongs to.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "CIDR of the IPv4 subnet.", + "length": 255, + "name": "subnet", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the account which the IPv4 subnet is dedicated to. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "dedicateIpv4SubnetForZone", + "response": [ + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the account of the IPv4 subnet", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the project id of the IPv4 subnet", + "name": "projectid", + "type": "string" + }, + { + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "type": "string" + }, + { + "description": "the project name of the IPv4 subnet", + "name": "project", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + { + "description": "guest IPv4 subnet", + "name": "subnet", + "type": "string" + }, + { + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the guest IPv4 subnet", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "type": "string" + }, + {} + ], + "since": "4.20.0" + }, + { + "description": "migrates resources from one secondary storage to destination image store", + "isasync": true, + "name": "migrateResourceToAnotherSecondaryStorage", + "params": [ + { + "description": "id of the image store from where the data is to be migrated", + "length": 255, + "name": "srcpool", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": true, + "type": "uuid" + }, + { + "description": "id(s) of the templates to be migrated", + "length": 255, + "name": "templates", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "list" + }, + { + "description": "id(s) of the snapshots to be migrated", + "length": 255, + "name": "snapshots", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", + "required": false, + "type": "list" + }, + { + "description": "id of the destination secondary storage pool to which the resources are to be migrated", + "length": 255, + "name": "destpool", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": true, + "type": "uuid" + } + ], + "related": "migrateSecondaryStorageData", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Response message from migration of secondary storage data objects", + "name": "message", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Type of migration requested for", + "name": "migrationtype", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.19.0" + }, + { + "description": "Deletes a keypair by name", + "isasync": false, + "name": "deleteSSHKeyPair", + "params": [ + { + "description": "the domain ID associated with the keypair", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the account associated with the keypair. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the project associated with keypair", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "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" + }, + {} + ] + }, + { + "description": "Searches LDAP based on the username attribute", + "isasync": false, + "name": "searchLdap", + "params": [ + { + "description": "query to search using", + "length": 255, + "name": "query", + "related": "searchLdap", + "required": true, + "type": "string" + }, + { + "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" + } + ], + "related": "", + "response": [ + { + "description": "The user's firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "The user's username", + "name": "username", + "type": "string" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The user's domain", + "name": "domain", + "type": "string" + }, + { + "description": "The user's principle", + "name": "principal", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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 email", + "name": "email", + "type": "string" + }, + { + "description": "The user's lastname", + "name": "lastname", + "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "Returns the status of CloudStack, whether a shutdown has been triggered and if ready to shutdown", + "isasync": false, + "name": "readyForShutdown", + "params": [ + { + "description": "the id of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": true, + "type": "uuid" + } + ], + "related": "prepareForShutdown", + "response": [ + {}, + { + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" + }, + { + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", + "type": "long" + }, + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" + }, + { + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "string" + }, + { + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + } + ], + "since": "4.19.0" + }, + { + "description": "create Tungsten-Fabric logical router", + "isasync": true, + "name": "createTungstenFabricLogicalRouter", + "params": [ + { + "description": "Tungsten-Fabric logical router name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "related": "removeTungstenFabricNetworkGatewayFromLogicalRouter", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric logical router name", + "name": "name", + "type": "string" + }, + { + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Start a Shared FileSystem", + "isasync": true, + "name": "startSharedFileSystem", + "params": [ + { + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" + } + ], + "related": "listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "response": [ + { + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" + }, + { + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" + }, + {}, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "the list of nics associated with the shared filesystem", + "name": "nic", + "response": [ + { + "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": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "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 IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + {}, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "name of the shared filesystem", + "name": "name", + "type": "string" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, + { + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + }, + { + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" + }, + { + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, + { + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "create Tungsten-Fabric firewall", + "isasync": true, + "name": "createTungstenFabricFirewallRule", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Tungsten-Fabric firewall rule destination tag uuid", + "length": 255, + "name": "desttaguuid", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule destination address group uuid", + "length": 255, + "name": "destaddressgroupuuid", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule tag type uuid", + "length": 255, + "name": "tagtypeuuid", + "required": false, + "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric firewall policy", + "length": 255, + "name": "firewallpolicyuuid", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule service group uuid", + "length": 255, + "name": "servicegroupuuid", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule direction", + "length": 255, + "name": "direction", + "required": true, + "type": "string" + }, + { + "description": "the sequence of Tungsten-Fabric firewall rule", + "length": 255, + "name": "sequence", + "required": true, + "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric destination network", + "length": 255, + "name": "destnetworkuuid", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule action", + "length": 255, + "name": "action", + "required": true, + "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric source network", + "length": 255, + "name": "srcnetworkuuid", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule source address group uuid", + "length": 255, + "name": "srcaddressgroupuuid", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule source tag uuid", + "length": 255, + "name": "srctaguuid", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "listTungstenFabricFirewallRule", + "response": [ + { + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric firewall rule action", + "name": "action", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", + "type": "string" + } + ] + }, + { + "description": "Lists all configurations.", + "isasync": false, + "name": "listConfigurations", + "params": [ + { + "description": "lists configuration by parent name (primarily used for UI)", + "length": 255, + "name": "parent", + "required": false, + "since": "4.18.0", + "type": "string" + }, + { + "description": "lists configuration by subgroup name (primarily used for UI)", + "length": 255, + "name": "subgroup", + "required": false, + "since": "4.18.0", + "type": "string" + }, + { + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "lists configurations by category", + "length": 255, + "name": "category", + "required": false, + "type": "string" + }, + { + "description": "the ID of the Domain to update the parameter value for corresponding domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "length": 255, + "name": "imagestoreuuid", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Zone to update the parameter value for corresponding zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "lists configuration by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "lists configuration by group name (primarily used for UI)", + "length": 255, + "name": "group", + "required": false, + "since": "4.18.0", + "type": "string" + }, + { + "description": "the ID of the Account to update the parameter value for corresponding account", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the group of the configuration", + "name": "group", + "type": "string" + }, + { + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", + "type": "string" + }, + { + "description": "the default value of the configuration", + "name": "defaultvalue", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the parent configuration", + "name": "parent", + "type": "string" + }, + { + "description": "the value of the configuration", + "name": "value", + "type": "string" + }, + {}, + {}, + { + "description": "the type of the configuration value", + "name": "type", + "type": "string" + }, + { + "description": "the name of the configuration", + "name": "name", + "type": "string" + }, + { + "description": "the description of the configuration", + "name": "description", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the subgroup of the configuration", + "name": "subgroup", + "type": "string" + }, + { + "description": "the category of the configuration", + "name": "category", + "type": "string" + }, + { + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" + }, + { + "description": "the component of the configuration", + "name": "component", + "type": "string" + }, + { + "description": "the possible options of the configuration value", + "name": "options", + "type": "string" + }, + { + "description": "the display text of the configuration", + "name": "displaytext", + "type": "string" + }, + { + "description": "the value of the configuration", + "name": "id", + "type": "long" + } + ] + }, + { + "description": "Scales a created, running or stopped CloudManaged Kubernetes cluster", + "isasync": true, + "name": "scaleKubernetesCluster", + "params": [ + { + "description": "(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter", + "length": 255, + "name": "nodeofferings", + "required": false, + "since": "4.21.0", + "type": "map" + }, + { + "description": "Minimum number of worker nodes in the cluster", + "length": 255, + "name": "minsize", + "required": false, + "type": "long" + }, + { + "description": "Whether autoscaling is enabled for the cluster", + "length": 255, + "name": "autoscalingenabled", + "required": false, + "type": "boolean" + }, + { + "description": "Maximum number of worker nodes in the cluster", + "length": 255, + "name": "maxsize", + "required": false, + "type": "long" + }, + { + "description": "the ID of the service offering for the virtual machines in the cluster.", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", + "required": true, + "type": "uuid" + }, + { + "description": "number of Kubernetes cluster nodes", + "length": 255, + "name": "size", + "required": false, + "type": "long" + }, + { + "description": "the IDs of the nodes to be removed", + "length": 255, + "name": "nodeids", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "list" + } + ], + "related": "createKubernetesCluster,startKubernetesCluster", + "response": [ + { + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", + "type": "string" + }, + { + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "Public IP Address of the cluster", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" + }, + { + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the state of the Kubernetes cluster", + "name": "state", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", + "type": "string" + }, + { + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" + }, + {}, + { + "description": "keypair details", + "name": "keypair", + "type": "string" + }, + { + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "the name of the Kubernetes cluster", + "name": "name", + "type": "string" + }, + { + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" + }, + { + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" + }, + { + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", + "type": "string" + }, + { + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" + }, + { + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", + "type": "string" + }, + { + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", + "type": "string" + }, + { + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, + { + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" + }, + { + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" + }, + { + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", + "type": "string" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" + }, + { + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", + "type": "string" + }, + { + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" + }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" + }, + { + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, + { + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" + }, + { + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, + { + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" + }, + { + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" + }, + { + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" + }, + { + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", + "type": "string" + } + ] + }, + { + "description": "Stops a NetScalervm.", + "isasync": true, + "name": "stopNetScalerVpx", + "params": [ + { + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the NetScaler vm", + "length": 255, + "name": "id", + "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" + } + ], + "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "response": [ + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + {}, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + } + ] + }, + { + "description": "Deletes a vm group", + "isasync": false, + "name": "deleteInstanceGroup", + "params": [ + { + "description": "the ID of the instance group", + "length": 255, + "name": "id", + "related": "updateInstanceGroup", + "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": "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": "Updates traffic type of a physical network", + "isasync": true, + "name": "updateTrafficType", + "params": [ + { + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "length": 255, + "name": "vmwarenetworklabel", + "required": false, + "type": "string" + }, + { + "description": "traffic type id", + "length": 255, + "name": "id", + "related": "addTrafficType,updateTrafficType", + "required": true, + "type": "uuid" + }, + { + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "length": 255, + "name": "ovm3networklabel", + "required": false, + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "length": 255, + "name": "hypervnetworklabel", + "required": false, + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "length": 255, + "name": "xennetworklabel", + "required": false, + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "length": 255, + "name": "kvmnetworklabel", + "required": false, + "type": "string" + } + ], + "related": "addTrafficType", + "response": [ + { + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", + "type": "string" + }, + {}, + { + "description": "the trafficType to be added to the physical network", + "name": "traffictype", + "type": "string" + }, + { + "description": "id of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", + "type": "string" + }, + { + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "List Conditions for VM auto scaling", + "isasync": false, + "name": "listConditions", + "params": [ + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "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": "List by keyword", + "length": 255, + "name": "keyword", + "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" + }, + { + "description": "the ID of the policy", + "length": 255, + "name": "policyid", + "related": "listAutoScalePolicies", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "Counter-id of the condition.", + "length": 255, + "name": "counterid", + "related": "createCounter", + "required": false, + "type": "uuid" + }, + { + "description": "ID of the Condition.", + "length": 255, + "name": "id", + "related": "listConditions", + "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": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the id of the Condition", + "name": "id", + "type": "string" + }, + { + "description": "the Id of the Counter.", + "name": "counterid", + "type": "string" + }, + {}, + { + "description": "the Name of the Counter.", + "name": "countername", + "type": "string" + }, + { + "description": "path of the domain to which the Condition owner belongs", + "name": "domainpath", + "type": "string" + }, + {}, + { + "description": "the domain id of the Condition owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the owner.", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the Condition.", + "name": "projectid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", + "type": "string" + }, + { + "description": "the project name of the Condition", + "name": "project", + "type": "string" + }, + { + "description": "zone id of counter", + "name": "zoneid", + "type": "string" + }, + { + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" + }, + { + "description": "the owner of the Condition.", + "name": "account", + "type": "string" + } + ] + }, + { + "description": "Adds a backup repository to store NAS backups", + "isasync": false, + "name": "addBackupRepository", + "params": [ + { + "description": "type of the backup repository storage. Supported values: nfs, cephfs, cifs", + "length": 255, + "name": "type", + "required": true, + "type": "string" + }, + { + "description": "shared storage mount options", + "length": 255, + "name": "mountopts", + "required": false, + "type": "string" + }, + { + "description": "ID of the zone where the backup repository is to be added", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "address of the backup repository", + "length": 255, + "name": "address", + "required": true, + "type": "string" + }, + { + "description": "capacity of this backup repository", + "length": 255, + "name": "capacitybytes", + "required": false, + "type": "long" + }, + { + "description": "backup repository provider", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + }, + { + "description": "name of the backup repository", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Zone ID of the backup repository", + "name": "zoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "backup type", + "name": "type", + "type": "string" + }, + { + "description": "the Zone name of the backup repository", + "name": "zonename", + "type": "string" + }, + { + "description": "the date and time the backup repository was added", + "name": "created", + "type": "date" + }, + {}, + { + "description": "the ID of the backup repository", + "name": "id", + "type": "string" + }, + { + "description": "the address / url of the backup repository", + "name": "address", + "type": "string" + }, + { + "description": "capacity of the backup repository", + "name": "capacitybytes", + "type": "long" + }, + { + "description": "the name of the backup repository", + "name": "name", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "migrates data objects from one secondary storage to destination image store(s)", + "isasync": true, + "name": "migrateSecondaryStorageData", + "params": [ + { + "description": "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated", + "length": 255, + "name": "destpools", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": true, + "type": "list" + }, + { + "description": "Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete", + "length": 255, + "name": "migrationtype", + "required": false, + "type": "string" + }, + { + "description": "id of the image store from where the data is to be migrated", + "length": 255, + "name": "srcpool", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "Type of migration requested for", + "name": "migrationtype", + "type": "string" + }, + {}, + { + "description": "Response message from migration of secondary storage data objects", + "name": "message", + "type": "string" + }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Destroys a Volume.", + "isasync": true, + "name": "destroyVolume", + "params": [ + { + "description": "The ID of the volume", + "length": 255, + "name": "id", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" + }, + { + "description": "If true is passed, the volume is expunged immediately. False by default.", + "length": 255, + "name": "expunge", + "required": false, + "since": "4.6.0", + "type": "boolean" + } + ], + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "response": [ + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + {}, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the path of the volume", + "name": "path", + "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": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + {}, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "Adds traffic type to a physical network", + "isasync": true, + "name": "addTrafficType", + "params": [ + { + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "length": 255, + "name": "kvmnetworklabel", + "required": false, + "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "updatePhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "length": 255, + "name": "xennetworklabel", + "required": false, + "type": "string" + }, + { + "description": "The VLAN id to be used for Management traffic by VMware host", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" + }, + { + "description": "Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.", + "length": 255, + "name": "isolationmethod", + "required": false, + "type": "string" + }, + { + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "length": 255, + "name": "ovm3networklabel", + "required": false, + "type": "string" + }, + { + "description": "the trafficType to be added to the physical network", + "length": 255, + "name": "traffictype", + "required": true, + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "length": 255, + "name": "hypervnetworklabel", + "required": false, + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "length": 255, + "name": "vmwarenetworklabel", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", + "type": "string" + }, + { + "description": "id of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the trafficType to be added to the physical network", + "name": "traffictype", + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", + "type": "string" + }, + { + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists the secondary storage selectors and their rules.", + "isasync": false, + "name": "listSecondaryStorageSelectors", + "params": [ + { + "description": "The zone ID to be used in the search filter.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "Show removed heuristics.", + "length": 255, + "name": "showremoved", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", + "type": "string" + }, + { + "description": "When the heuristic was created.", + "name": "created", + "type": "date" + }, + { + "description": "Name of the heuristic.", + "name": "name", + "type": "string" + }, + { + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" + }, + {}, + { + "description": "ID of the heuristic.", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", + "type": "string" + }, + { + "description": "Description of the heuristic.", + "name": "description", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "List all virtual machine instances that are assigned to a load balancer rule.", + "isasync": false, + "name": "listLoadBalancerRuleInstances", + "params": [ + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "true if load balancer rule VM IP information to be included; default is false", + "length": 255, + "name": "lbvmips", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", + "length": 255, + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "listLoadBalancerRuleInstances", + "response": [ + { + "description": "the user vm set for lb rule", + "name": "loadbalancerruleinstance", + "type": "uservmresponse" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "IP addresses of the vm set of lb rule", + "name": "lbvmipaddresses", + "type": "list" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Removes a condition for VM auto scaling", + "isasync": true, + "name": "deleteCondition", + "params": [ + { + "description": "the ID of the condition.", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Updates a physical network", + "isasync": true, + "name": "updatePhysicalNetwork", + "params": [ + { + "description": "physical network id", + "length": 255, + "name": "id", + "related": "updatePhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "Enabled/Disabled", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "Tag the physical network", + "length": 255, + "name": "tags", + "required": false, + "type": "list" + }, + { + "description": "the speed for the physical network[1G/10G]", + "length": 255, + "name": "networkspeed", + "required": false, + "type": "string" + }, + { + "description": "the VLAN for the physical network", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "comma separated tag", + "name": "tags", + "type": "string" + }, + { + "description": "the speed of the physical network", + "name": "networkspeed", + "type": "string" + }, + { + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", + "type": "string" + }, + { + "description": "the domain id of the physical network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name of the physical network", + "name": "name", + "type": "string" + }, + {}, + { + "description": "state of the physical network", + "name": "state", + "type": "string" + }, + { + "description": "the vlan of the physical network", + "name": "vlan", + "type": "string" + }, + { + "description": "zone id of the physical network", + "name": "zoneid", + "type": "string" + }, + { + "description": "the uuid of the physical network", + "name": "id", + "type": "string" + }, + { + "description": "isolation methods", + "name": "isolationmethods", + "type": "string" + }, + { + "description": "zone name of the physical network", + "name": "zonename", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Stop a Shared FileSystem", + "isasync": true, + "name": "stopSharedFileSystem", + "params": [ + { + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" + }, + { + "description": "Force stop the shared filesystem.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + } + ], + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "response": [ + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + {}, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" + }, + { + "description": "the list of nics associated with the shared filesystem", + "name": "nic", + "response": [ + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" + }, + {}, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "name of the shared filesystem", + "name": "name", + "type": "string" + }, + { + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Creates a vGPU profile in the system", + "isasync": false, + "name": "createVgpuProfile", + "params": [ + { + "description": "the name of the vGPU profile", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Max vGPU per physical GPU. This is used to calculate capacity.", + "length": 255, + "name": "maxvgpuperphysicalgpu", + "required": false, + "type": "long" + }, + { + "description": "the maximum X resolution", + "length": 255, + "name": "maxresolutionx", + "required": false, + "type": "long" + }, + { + "description": "the video RAM size in MB", + "length": 255, + "name": "videoram", + "required": false, + "type": "long" + }, + { + "description": "the maximum number of display heads", + "length": 255, + "name": "maxheads", + "required": false, + "type": "long" + }, + { + "description": "the maximum Y resolution", + "length": 255, + "name": "maxresolutiony", + "required": false, + "type": "long" + }, + { + "description": "the description of the vGPU profile", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "the GPU card ID associated with this GPU device", + "length": 255, + "name": "gpucardid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the device name of the GPU card", + "name": "devicename", + "type": "string" + }, + { + "description": "the display name of the GPU card", + "name": "name", + "type": "string" + }, + { + "description": "the maximum number of vGPUs per physical GPU", + "name": "maxvgpuperphysicalgpu", + "type": "long" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the vendor name of the GPU card", + "name": "vendorname", + "type": "string" + }, + { + "description": "the vendor ID of the GPU card", + "name": "vendorid", + "type": "string" + }, + {}, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the ID of the GPU card associated with this vGPU profile", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the name of the vGPU profile", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the ID of the GPU card", + "name": "id", + "type": "string" + }, + { + "description": "the device ID of the GPU card", + "name": "deviceid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the description of the vGPU profile", + "name": "description", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ], + "since": "4.21.0" + }, + { + "description": "create Tungsten-Fabric management network", + "isasync": false, + "name": "createTungstenFabricManagementNetwork", + "params": [ + { + "description": "the ID of pod", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "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" + } + ] + }, + { + "description": "list Tungsten-Fabric firewall rule", + "isasync": false, + "name": "listTungstenFabricFirewallRule", + "params": [ + { + "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 firewall rule", + "length": 255, + "name": "firewallruleuuid", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric firewall policy", + "length": 255, + "name": "firewallpolicyuuid", + "required": false, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule action", + "name": "action", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric firewall rule name", + "name": "name", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", + "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": "list all Netris providers added to CloudStack", + "isasync": false, + "name": "listNetrisProviders", + "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": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + } + ], + "related": "deleteNetrisProvider", + "response": [ + { + "description": "Netris provider uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Zone ID to which the Netris Provider is associated with", + "name": "zoneid", + "type": "string" + }, + { + "description": "Netris Admin tenant name", + "name": "tenantname", + "type": "string" + }, + {}, + { + "description": "Netris Provider site", + "name": "sitename", + "type": "string" + }, + { + "description": "Zone name to which the Netris Provider is associated with", + "name": "zonename", + "type": "string" + }, + { + "description": "Netris Provider URL", + "name": "netrisurl", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Netris Provider name", + "name": "name", + "type": "string" + }, + { + "description": "Netris Tag for vNets", + "name": "netristag", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.21.0" + }, + { + "description": "Creates a project", + "isasync": true, + "name": "createProject", + "params": [ + { + "description": "account who will be Admin for the project", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin", + "length": 255, + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": false, + "since": "4.15.0", + "type": "uuid" + }, + { + "description": "name of the project", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "domain ID of the account owning a project", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "The display text of the project, defaults to the 'name´.", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "ID of the account owning a project", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the total number of backups available to this project", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", + "type": "string" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the id of the project", + "name": "id", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" + }, + { + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", + "type": "string" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of gpus the project can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", + "type": "string" + }, + { + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the state of the project", + "name": "state", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of buckets available to this project", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the name of the project", + "name": "name", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + } + ], + "since": "3.0.0" + }, + { + "description": "Assigns a certificate to a load balancer rule", + "isasync": true, + "name": "assignCertToLoadBalancer", + "params": [ + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "createPortForwardingRule,updatePortForwardingRule", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the certificate", + "length": 255, + "name": "certid", + "related": "", + "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": "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": "Adds a Cisco Vnmc Controller", + "isasync": false, + "name": "addCiscoVnmcResource", + "params": [ + { + "description": "Hostname or ip address of the Cisco VNMC Controller.", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "Credentials to access the Cisco VNMC Controller API", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "Credentials to access the Cisco VNMC Controller API", + "length": 255, + "name": "username", + "required": true, + "type": "string" + } + ], + "related": "listCiscoVnmcResources", + "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": "Marks a default zone for this account", + "isasync": true, + "name": "markDefaultZoneForAccount", + "params": [ + { + "description": "Marks the account that belongs to the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" + }, + { + "description": "Name of the account that is to be marked.", + "length": 255, + "name": "account", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "required": true, + "type": "string" + }, + { + "description": "The Zone ID with which the account is to be marked.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "response": [ + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" + }, + {}, + { + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the total number of backups available to this account", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of gpus the account can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "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 total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + {}, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", + "type": "string" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + } + ], + "since": "4.0" + }, + { + "description": "Revokes certificate using configured CA plugin", + "isasync": true, + "name": "revokeCertificate", + "params": [ + { + "description": "The certificate serial number, as a hex value", + "length": 255, + "name": "serial", + "required": true, + "type": "string" + }, + { + "description": "The certificate CN", + "length": 255, + "name": "cn", + "required": false, + "type": "string" + }, + { + "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.11.0" + }, + { + "description": "Deletes a routing firewall rule", + "isasync": true, + "name": "deleteRoutingFirewallRule", + "params": [ + { + "description": "the ID of the Routing firewall rule", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule", + "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 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.20.0" + }, + { + "description": "Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a \"Stopped\" state for this command to take effect.", + "isasync": false, + "name": "changeServiceForSystemVm", + "params": [ + { + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "The ID of the system vm", + "length": 255, + "name": "id", + "related": "startSystemVm,changeServiceForSystemVm", + "required": true, + "type": "uuid" + }, + { + "description": "the service offering ID to apply to the system vm", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + } + ], + "related": "startSystemVm", + "response": [ + { + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" + }, + { + "description": "CPU arch of the system VM", + "name": "arch", + "type": "string" + }, + {}, + { + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" + }, + { + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" + }, + { + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" + }, + { + "description": "the name of the system VM", + "name": "name", + "type": "string" + }, + { + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" + }, + { + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" + }, + { + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "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 service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" + }, + { + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" + }, + { + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" + }, + { + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" + }, + { + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the ID of the system VM", + "name": "id", + "type": "string" + }, + { + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" + }, + { + "description": "the state of the system VM", + "name": "state", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the second DNS for the system VM", + "name": "dns2", + "type": "string" + }, + { + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", + "type": "string" + }, + { + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the systemvm agent version", + "name": "version", + "type": "string" + }, + { + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" + }, + { + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" + }, + { + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" + }, + { + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" + } + ] + }, + { + "description": "Update SIOC info", + "isasync": false, + "name": "updateSiocInfo", + "params": [ + { + "description": "Shares per GB", + "length": 255, + "name": "sharespergb", + "required": true, + "type": "integer" + }, + { + "description": "Storage Pool ID", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" + }, + { + "description": "Limit IOPS per GB", + "length": 255, + "name": "limitiopspergb", + "required": true, + "type": "integer" + }, + { + "description": "Zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Notify if IOPS above this value", + "length": 255, + "name": "iopsnotifythreshold", + "required": true, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The return message from the operation ('Success' if successful)", + "name": "msg", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ], + "since": "4.11.0" + }, + { + "description": "Deletes a vmsnapshot.", + "isasync": true, + "name": "deleteVMSnapshot", + "params": [ + { + "description": "The ID of the VM snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "Lists console sessions.", + "isasync": false, + "name": "listConsoleSessions", + "params": [ + { + "description": "Lists only active console sessions, defaults to true. Active sessions are the ones that have been acquired and have not been removed.", + "length": 255, + "name": "activeonly", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "IP address of the client that accessed the console session.", + "length": 255, + "name": "clientaddress", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "The ID of the console session.", + "length": 255, + "name": "id", + "related": "listConsoleSessions", + "required": false, + "type": "uuid" + }, + { + "description": "The domain ID of the account that created the console endpoint.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Lists console sessions generated from this date onwards. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, + { + "description": "The ID of the user that created the console endpoint.", + "length": 255, + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the account that created the console endpoint.", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "Lists console sessions recursively per domain. If an account ID is informed, only the account's console sessions will be listed. Defaults to false.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "IP address of the creator of the console endpoint.", + "length": 255, + "name": "consoleendpointcreatoraddress", + "required": false, + "type": "string" + }, + { + "description": "Lists console sessions from the specified host.", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "The ID of the virtual machine.", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "Lists console sessions generated up until this date. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" + }, + { + "description": "Lists acquired console sessions, defaults to false. Acquired console sessions are the ones that have been accessed. The 'activeonly' parameter has precedence over the 'acquired' parameter, i.e., when the 'activeonly' parameter is 'true', the 'acquired' parameter value will be ignored.", + "length": 255, + "name": "acquired", + "required": false, + "type": "boolean" + } + ], + "related": "", + "response": [ + { + "description": "Name of the host.", + "name": "hostname", + "type": "string" + }, + { + "description": "Date when the console session was removed.", + "name": "removed", + "type": "date" + }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the host.", + "name": "hostid", + "type": "string" + }, + { + "description": "Name of the virtual machine.", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "ID of the console session.", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Date when the console session's endpoint was created.", + "name": "created", + "type": "date" + }, + { + "description": "Date when the console session was acquired.", + "name": "acquired", + "type": "date" + }, + { + "description": "ID of the user that created the console endpoint.", + "name": "userid", + "type": "string" + }, + { + "description": "IP address of the creator of the console endpoint.", + "name": "consoleendpointcreatoraddress", + "type": "string" + }, + { + "description": "Domain of the account that created the console endpoint.", + "name": "domain", + "type": "string" + }, + { + "description": "Domain ID of the account that created the console endpoint.", + "name": "domainid", + "type": "string" + }, + { + "description": "User that created the console endpoint.", + "name": "user", + "type": "string" + }, + { + "description": "Account that created the console endpoint.", + "name": "account", + "type": "string" + }, + { + "description": "ID of the account that created the console endpoint.", + "name": "accountid", + "type": "string" + }, + { + "description": "IP address of the client that created the console session.", + "name": "clientaddress", + "type": "string" + }, + { + "description": "Domain path of the account that created the console endpoint.", + "name": "domainpath", + "type": "string" + }, + { + "description": "ID of the virtual machine.", + "name": "virtualmachineid", + "type": "string" + } + ], + "since": "4.21.0" + }, + { + "description": "Unmanage a guest virtual machine.", + "isasync": true, + "name": "unmanageVirtualMachine", + "params": [ + { + "description": "The ID of the virtual machine to unmanage", + "length": 255, + "name": "id", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "details of the unmanage VM operation", + "name": "details", + "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": "result of the unmanage VM operation", + "name": "success", + "type": "boolean" + }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Starts a router.", + "isasync": true, + "name": "rebootRouter", + "params": [ + { + "description": "the ID of the router", + "length": 255, + "name": "id", + "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" + }, + { + "description": "Force reboot the router (Router is force Stopped and then Started)", + "length": 255, + "name": "forced", + "required": false, + "since": "4.16.0", + "type": "boolean" + } + ], + "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "response": [ + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + {}, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + } + ] + }, + { + "description": "list the vm nics IP to NIC", + "isasync": false, + "name": "listNics", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list nic of the specific vm's network", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the ID of the nic to list IPs", + "length": 255, + "name": "nicid", + "related": "listNics", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + {}, + {}, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + } + ] + }, + { + "description": "List user data for CNI plugins", + "isasync": false, + "name": "listCniConfiguration", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "Userdata name to look for", + "length": 255, + "name": "name", + "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": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "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": "the ID of the Userdata", + "length": 255, + "name": "id", + "related": "listCniConfiguration", + "required": false, + "type": "uuid" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "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": "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": "", + "response": [ + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain id of the User Data owner", + "name": "domainid", + "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 the User Data", + "name": "params", + "type": "string" + }, + { + "description": "the domain name of the User Data owner", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the User Data", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "ID of the User Data", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "path of the domain to which the User Data owner belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "base64 encoded User Data content", + "name": "userdata", + "type": "string" + }, + { + "description": "the project name of the User Data", + "name": "project", + "type": "string" + }, + { + "description": "Name of the User Data", + "name": "name", + "type": "string" + }, + { + "description": "the owner id of the User Data", + "name": "accountid", + "type": "string" + }, + { + "description": "the owner of the User Data", + "name": "account", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.21.0" + }, + { + "description": "Lists Bgp Peers.", + "isasync": false, + "name": "listBgpPeers", + "params": [ + { + "description": "AS number of the Bgp Peer.", + "length": 255, + "name": "asnumber", + "required": false, + "type": "long" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "Lists only dedicated or non-dedicated Bgp Peers. If not set, lists all dedicated and non-dedicated BGP peers the domain/account can access.", + "length": 255, + "name": "isdedicated", + "required": false, + "type": "boolean" + }, + { + "description": "the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "project who which the Bgp Peer is dedicated to", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "UUID of the Bgp Peer.", + "length": 255, + "name": "id", + "related": "listBgpPeers,releaseBgpPeer", + "required": false, + "type": "uuid" + }, + { + "description": "UUID of zone to which the Bgp Peer belongs to.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the domain ID which the Bgp Peer is dedicated to.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "releaseBgpPeer", + "response": [ + { + "description": "the account of the bgp peer", + "name": "account", + "type": "string" + }, + { + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "id of the bgp peer", + "name": "id", + "type": "string" + }, + { + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, + {}, + { + "description": "the domain name of the bgp peer", + "name": "domain", + "type": "string" + }, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" + }, + { + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" + }, + { + "description": "IPv4 address of bgp peer", + "name": "ipaddress", + "type": "string" + }, + { + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "password of bgp peer", + "name": "password", + "type": "string" + }, + { + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" + }, + { + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" + }, + { + "description": "the project id of the bgp peer", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Creates an instant snapshot of a volume from existing vm snapshot.", + "isasync": true, + "name": "createSnapshotFromVMSnapshot", + "params": [ + { + "description": "the name of the snapshot", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "The ID of the VM snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": true, + "type": "uuid" + }, + { + "description": "The ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" + } + ], + "related": "copySnapshot,archiveSnapshot,listSnapshots", + "response": [ + {}, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "name of the snapshot", + "name": "name", + "type": "string" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" + }, + { + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the project name of the snapshot", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "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": "tag key name", + "name": "key", + "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" + } + ], + "type": "set" + }, + { + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" + }, + { + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" + }, + { + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, + { + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", + "type": "long" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "ID of the snapshot", + "name": "id", + "type": "string" + }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" + }, + { + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "volumename", + "type": "string" + }, + { + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + } + ], + "since": "4.10.0" + }, + { + "description": "Lists objects at specified path on an image store.", + "isasync": false, + "name": "listImageStoreObjects", + "params": [ + { + "description": "path to list on image store", + "length": 255, + "name": "path", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "id of the image store", + "length": 255, + "name": "id", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", + "type": "string" + }, + { + "description": "Format of template associated with the data store object.", + "name": "format", + "type": "string" + }, + { + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Size is in Bytes.", + "name": "size", + "type": "long" + }, + { + "description": "Template Name associated with the data store object.", + "name": "templatename", + "type": "string" + }, + {}, + { + "description": "Volume Name associated with the data store object.", + "name": "volumename", + "type": "string" + }, + { + "description": "Name of the data store object.", + "name": "name", + "type": "string" + }, + { + "description": "Is it a directory.", + "name": "isdirectory", + "type": "boolean" + }, + { + "description": "Volume ID associated with the data store object.", + "name": "volumeid", + "type": "string" + }, + { + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", + "type": "string" + }, + { + "description": "Template ID associated with the data store object.", + "name": "templateid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Dedicates a guest vlan range to an account", + "isasync": false, + "name": "dedicateGuestVlanRange", + "params": [ + { + "description": "guest vlan range to be dedicated", + "length": 255, + "name": "vlanrange", + "required": true, + "type": "string" + }, + { + "description": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "physical network ID of the vlan", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "account who will own the VLAN", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "domain ID of the account owning a VLAN", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the zone of the guest vlan range", + "name": "zoneid", + "type": "long" + }, + { + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" + }, + { + "description": "the project name of the guest vlan range", + "name": "project", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain ID of the guest VLAN range", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the guest VLAN range", + "name": "id", + "type": "string" + }, + { + "description": "the guest VLAN range", + "name": "guestvlanrange", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain name of the guest VLAN range", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the guest vlan range", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "the account of the guest VLAN range", + "name": "account", + "type": "string" + } + ] + }, + { + "description": "Updates an ISO file.", + "isasync": false, + "name": "updateIso", + "params": [ + { + "description": "true if the template type is routing i.e., if template is used to deploy router", + "length": 255, + "name": "isrouting", + "required": false, + "type": "boolean" + }, + { + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the format for the image", + "length": 255, + "name": "format", + "required": false, + "type": "string" + }, + { + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" + }, + { + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" + }, + { + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" + }, + { + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" + }, + { + "description": "Force OS type update. Warning: Updating OS type will update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.", + "length": 255, + "name": "forceupdateostype", + "required": false, + "since": "4.21", + "type": "boolean" + }, + { + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" + }, + { + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the OS type that best represents the OS of this image.", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the image file", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + }, + { + "description": "true if the image supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "the name of the image file", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + {}, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "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 ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + {}, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "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": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + } + ] + }, + { + "description": "Deletes a counter for VM auto scaling", + "isasync": true, + "name": "deleteCounter", + "params": [ + { + "description": "the ID of the counter", + "length": 255, + "name": "id", + "related": "createCounter", + "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": "Issues a client certificate using configured or provided CA plugin", + "isasync": true, + "name": "issueCertificate", + "params": [ + { + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + }, + { + "description": "Certificate validity duration in number of days, when not provided the default configured value will be used", + "length": 255, + "name": "duration", + "required": false, + "type": "integer" + }, + { + "description": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered", + "length": 65535, + "name": "csr", + "required": false, + "type": "string" + }, + { + "description": "Comma separated list of IP addresses, the certificate should be issued for", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, + { + "description": "Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN", + "length": 255, + "name": "domain", + "required": false, + "type": "string" + } + ], + "related": "listCaCertificate", + "response": [ + { + "description": "The client certificate", + "name": "certificate", + "type": "string" + }, + { + "description": "The CA certificate(s)", + "name": "cacertificates", + "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": "Private key for the certificate", + "name": "privatekey", + "type": "string" + } + ], + "since": "4.11.0" + }, + { + "description": "Creates a port forwarding rule", + "isasync": true, + "name": "createPortForwardingRule", + "params": [ + { + "description": "VM guest nic secondary IP address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, + "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" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "length": 255, + "name": "privateport", + "required": true, + "type": "integer" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "length": 255, + "name": "publicendport", + "required": false, + "type": "integer" + }, + { + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true", + "length": 255, + "name": "openfirewall", + "required": false, + "type": "boolean" + }, + { + "description": "the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "length": 255, + "name": "privateendport", + "required": false, + "type": "integer" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "length": 255, + "name": "publicport", + "required": true, + "type": "integer" + }, + { + "description": " the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed.", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" + }, + { + "description": "the IP address id of the port forwarding rule", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the virtual machine for the port forwarding rule", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "updatePortForwardingRule", + "response": [ + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + {}, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + {}, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + } + ] + }, + { + "description": "Dedicates a zones.", + "isasync": true, + "name": "dedicateZone", + "params": [ + { + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the ID of the dedicated resource", + "name": "id", + "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": "the domain ID to which the Zone is dedicated", + "name": "domainid", + "type": "string" + }, + { + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", + "type": "string" + }, + { + "description": "the Name of the Zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the Zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", + "type": "string" + }, + {} + ] + }, + { + "description": "load template into primary storage", + "isasync": false, + "name": "prepareTemplate", + "params": [ + { + "description": "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools.", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "zone ID of the template to be prepared in primary storage(s).", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "template ID of the template to be prepared in primary storage(s).", + "length": 255, + "name": "templateid", + "related": "prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + } + ], + "related": "listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + {}, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "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 project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + {}, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + } + ] + }, + { + "description": "Updates a backup offering.", + "isasync": false, + "name": "updateBackupOffering", + "params": [ + { + "description": "The name of the Backup Offering to be updated", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "Whether to allow user driven backups or not", + "length": 255, + "name": "allowuserdrivenbackups", + "required": false, + "type": "boolean" + }, + { + "description": "The description of the Backup Offering to be updated", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "The ID of the Backup Offering to be updated", + "length": 255, + "name": "id", + "related": "updateBackupOffering", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "name for the backup offering", + "name": "name", + "type": "string" + }, + { + "description": "external ID on the provider side", + "name": "externalid", + "type": "string" + }, + { + "description": "zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "provider name", + "name": "provider", + "type": "string" + }, + { + "description": "the date this backup offering was created", + "name": "created", + "type": "date" + }, + { + "description": "zone ID", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "description for the backup offering", + "name": "description", + "type": "string" + }, + {}, + { + "description": "ID of the backup offering", + "name": "id", + "type": "string" + }, + { + "description": "whether offering allows user driven ad-hoc/scheduled backups", + "name": "allowuserdrivenbackups", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.16.0" + }, + { + "description": "Lists all Buckets.", + "isasync": false, + "name": "listBuckets", + "params": [ + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the bucket", + "length": 255, + "name": "id", + "related": "listBuckets", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the name of the bucket", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the ID of the object storage pool, available to ROOT admin only", + "length": 255, + "name": "objectstorageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "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" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the IDs of the Buckets, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "listBuckets", + "required": false, + "type": "list" + }, + { + "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 objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "Bucket Encryption", + "name": "encryption", + "type": "boolean" + }, + {}, + { + "description": "the ID of the domain associated with the bucket", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Bucket Access Policy", + "name": "policy", + "type": "string" + }, + { + "description": "Bucket URL", + "name": "url", + "type": "string" + }, + { + "description": "Bucket Secret Key", + "name": "usersecretkey", + "type": "string" + }, + { + "description": "the account associated with the Bucket", + "name": "account", + "type": "string" + }, + { + "description": "the date the Bucket was created", + "name": "created", + "type": "date" + }, + { + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "name of the Bucket", + "name": "name", + "type": "string" + }, + { + "description": "State of the Bucket", + "name": "state", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain associated with the bucket", + "name": "domain", + "type": "string" + }, + { + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" + }, + { + "description": "ID of the Bucket", + "name": "id", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Object storage provider", + "name": "provider", + "type": "string" + }, + { + "description": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", + "type": "string" + }, + { + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" + }, + { + "description": "the project id of the bucket", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the bucket", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", + "type": "string" + }, + { + "description": "Bucket Quota in GiB", + "name": "quota", + "type": "integer" + }, + { + "description": "Bucket Access Key", + "name": "accesskey", + "type": "string" + }, + { + "description": "Bucket Object Locking", + "name": "objectlocking", + "type": "boolean" + } + ], + "since": "4.19.0" + }, + { + "description": "Stops an Internal LB vm.", + "isasync": true, + "name": "stopInternalLoadBalancerVM", + "params": [ + { + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the internal lb vm", + "length": 255, + "name": "id", + "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" + } + ], + "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "response": [ + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + {}, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + } + ] + }, + { + "description": "Updates a security group", + "isasync": false, + "name": "updateSecurityGroup", + "params": [ + { + "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": "The new name of the security group.", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "The ID of the security group.", + "length": 255, + "name": "id", + "related": "updateSecurityGroup", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "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" + } + ], + "type": "set" + }, + {}, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" + }, + { + "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.14.0.0" + }, + { + "description": "Creates a GPU device manually on a host", + "isasync": false, + "name": "createGpuDevice", + "params": [ + { + "description": "PCI bus address of the GPU device (e.g., 0000:01:00.0) or UUID for MDEV devices.", + "length": 255, + "name": "busaddress", + "required": true, + "type": "string" + }, + { + "description": "ID of the host where the GPU device is located", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": true, + "type": "uuid" + }, + { + "description": "ID of the parent GPU device (for virtual GPU devices)", + "length": 255, + "name": "parentgpudeviceid", + "related": "listGpuDevices,discoverGpuDevices,createGpuDevice", + "required": false, + "type": "uuid" + }, + { + "description": "Type of GPU device (PCI, MDEV, VGPUOnly). Defaults to PCI.", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "ID of the vGPU profile", + "length": 255, + "name": "vgpuprofileid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "ID of the GPU card type", + "length": 255, + "name": "gpucardid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "NUMA node of the GPU device (e.g., 0, 1, etc.). This is optional and can be used to specify the NUMA node for the GPU device which is used during allocation. Defaults to -1", + "length": 255, + "name": "numanode", + "required": false, + "type": "string" + } + ], + "related": "listGpuDevices,discoverGpuDevices", + "response": [ + { + "description": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" + }, + { + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the host name where the GPU device is attached", + "name": "hostname", + "type": "string" + }, + { + "description": "the ID of the GPU device", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the managed state of the GPU device (Enabled/Disabled)", + "name": "managedstate", + "type": "managedstate" + }, + { + "description": "the state of the virtual machine to which this GPU device is allocated", + "name": "vmstate", + "type": "state" + }, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", + "type": "string" + }, + { + "description": "the host ID where the GPU device is attached", + "name": "hostid", + "type": "string" + }, + { + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "state", + "type": "state" + }, + { + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the GPU card name associated with this GPU device", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the NUMA node where the GPU device is located", + "name": "numanode", + "type": "string" + }, + {} + ], + "since": "4.21.0" + }, + { + "description": "Creates a domain", + "isasync": false, + "name": "createDomain", + "params": [ + { + "description": "creates domain with this name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.", + "length": 255, + "name": "parentdomainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Domain UUID, required for adding domain from another Region", + "length": 255, + "name": "domainid", + "required": false, + "type": "string" + }, + { + "description": "Network domain for networks in the domain", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" + } + ], + "related": "listDomains,listDomains", + "response": [ + { + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", + "type": "string" + }, + { + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" + }, + {}, + { + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of gpus the domain can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "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 ID of the domain", + "name": "id", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total number of gpus owned by domain", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of backups available to this domain", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the state of the domain", + "name": "state", + "type": "string" + }, + { + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the name of the domain", + "name": "name", + "type": "string" + }, + { + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", + "type": "string" + }, + { + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" + } + ] + }, + { + "description": "Adds backup image store.", + "isasync": false, + "name": "addImageStore", + "params": [ + { + "description": "the URL for the image store", + "length": 2048, + "name": "url", + "required": false, + "type": "string" + }, + { + "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "the Zone ID for the image store", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the image store provider name", + "length": 255, + "name": "provider", + "required": true, + "type": "string" + }, + { + "description": "the name for the image store", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "addSecondaryStorage,listSwifts", + "response": [ + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" + }, + { + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + { + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + {} + ], + "since": "4.2.0" + }, + { + "description": "Revoke a direct download certificate from hosts in a zone", + "isasync": false, + "name": "revokeTemplateDirectDownloadCertificate", + "params": [ + { + "description": "(optional) zone to revoke certificate", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "(optional) hypervisor type", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "id of the certificate", + "length": 255, + "name": "id", + "related": "listTemplateDirectDownloadCertificates", + "required": false, + "type": "uuid" + }, + { + "description": "(optional) the host ID to revoke certificate", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "(optional) alias of the SSL certificate", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "provisionTemplateDirectDownloadCertificate", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "indicates the details in case of failure or host skipped", + "name": "details", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", + "type": "string" + }, + {}, + {}, + { + "description": "the name of the host", + "name": "hostname", + "type": "string" + } + ], + "since": "4.13" + }, + { + "description": "Syncs capabilities of storage pools", + "isasync": false, + "name": "updateStorageCapabilities", + "params": [ + { + "description": "Storage pool id", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" + } + ], + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "response": [ + { + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" + }, + { + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the storage pool path", + "name": "path", + "type": "string" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + {}, + { + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" + }, + { + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" + }, + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the storage pool details", + "name": "details", + "type": "map" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" + }, + { + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" + }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the storage pool", + "name": "id", + "type": "string" + }, + { + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the storage pool type", + "name": "type", + "type": "string" + } + ], + "since": "4.16.0" + }, + { + "description": "Unregister an extension with a resource", + "isasync": false, + "name": "unregisterExtension", + "params": [ + { + "description": "Type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" + }, + { + "description": "ID of the resource to register the extension with", + "length": 255, + "name": "resourceid", + "required": true, + "type": "string" + }, + { + "description": "ID of the extension", + "length": 255, + "name": "extensionid", + "related": "listExtensions,updateExtension,unregisterExtension", + "required": true, + "type": "uuid" + } + ], + "related": "listExtensions,updateExtension", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" + }, + { + "description": "List of resources to which extension is registered to", + "name": "resources", + "response": [ + { + "description": "Type of the resource", + "name": "type", + "type": "string" + }, + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "type": "string" + }, + { + "description": "the details of the resource map", + "name": "details", + "type": "map" + }, + { + "description": "ID of the resource associated with the extension", + "name": "id", + "type": "string" + }, + { + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" + } + ], + "type": "list" + }, + { + "description": "The details of the extension", + "name": "details", + "type": "map" + }, + { + "description": "Description of the extension", + "name": "description", + "type": "string" + }, + { + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" + }, + { + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" + }, + { + "description": "Type of the extension", + "name": "type", + "type": "string" + }, + { + "description": "The state of the extension", + "name": "state", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The path of the entry point fo the extension", + "name": "path", + "type": "string" + }, + {}, + { + "description": "Name of the extension", + "name": "name", + "type": "string" + }, + { + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" + }, + {}, + { + "description": "ID of the extension", + "name": "id", + "type": "string" + }, + {} + ], + "since": "4.21.0" + }, + { + "description": "Changes ownership of a Volume from one account to another.", + "isasync": false, + "name": "assignVolume", + "params": [ + { + "description": "The ID of the volume to be reassigned.", + "length": 255, + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" + }, + { + "description": "The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'.", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "required": false, + "type": "uuid" + } + ], + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "response": [ + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + {}, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + {}, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "pod name of the volume", + "name": "podname", + "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 write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + } + ], + "since": "4.18.0.0" + }, + { + "description": "Deletes a userdata", + "isasync": false, + "name": "deleteUserData", + "params": [ + { + "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Userdata", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "an optional project for the userdata", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the userdata. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.18" + }, + { + "description": "Lists all network services provided by CloudStack or for the given Provider.", + "isasync": false, + "name": "listSupportedNetworkServices", + "params": [ + { + "description": "network service provider name", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "network service name to list providers and capabilities of", + "length": 255, + "name": "service", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "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" + } + ], + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ], + "since": "3.0.0" + }, + { + "description": "Deletes a particular ingress rule from this security group", + "isasync": true, + "name": "revokeSecurityGroupIngress", + "params": [ + { + "description": "The ID of the ingress rule", + "length": 255, + "name": "id", + "related": "authorizeSecurityGroupIngress", + "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": "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": "Adds a network serviceProvider to a physical network", + "isasync": true, + "name": "addNetworkServiceProvider", + "params": [ + { + "description": "the list of services to be enabled for this physical network service provider", + "length": 255, + "name": "servicelist", + "required": false, + "type": "list" + }, + { + "description": "the Physical Network ID to add the provider to", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "the name for the physical network service provider", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the destination Physical Network ID to bridge to", + "length": 255, + "name": "destinationphysicalnetworkid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "listTrafficTypes", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + {}, + {}, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Delete site to site vpn gateway", + "isasync": true, + "name": "deleteVpnGateway", + "params": [ + { + "description": "id of customer gateway", + "length": 255, + "name": "id", + "related": "updateVpnGateway", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "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": "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": "Creates a service offering.", + "isasync": false, + "name": "createServiceOffering", + "params": [ + { + "description": "max iops of the compute offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.4", + "type": "long" + }, + { + "description": "Count of GPUs to be used with this service offering. This is applicable only when passed with vGPU profile.", + "length": 255, + "name": "gpucount", + "required": false, + "since": "4.21", + "type": "integer" + }, + { + "description": "Lease expiry action, valid values are STOP and DESTROY", + "length": 255, + "name": "leaseexpiryaction", + "required": false, + "since": "4.21.0", + "type": "string" + }, + { + "description": "The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used", + "length": 255, + "name": "deploymentplanner", + "required": false, + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "required": false, + "type": "long" + }, + { + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "length": 255, + "name": "cachemode", + "required": false, + "since": "4.14", + "type": "string" + }, + { + "description": "the total memory of the service offering in MB", + "length": 255, + "name": "memory", + "required": false, + "type": "integer" + }, + { + "description": "burst requests read rate of the disk offering", + "length": 255, + "name": "iopsreadratemax", + "required": false, + "type": "long" + }, + { + "description": "The maximum memory size of the custom service offering in MB", + "length": 255, + "name": "maxmemory", + "required": false, + "since": "4.13", + "type": "integer" + }, + { + "description": "the Root disk size in GB.", + "length": 255, + "name": "rootdisksize", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "io requests write rate of the disk offering", + "length": 255, + "name": "iopswriterate", + "required": false, + "type": "long" + }, + { + "description": "the ID of the containing zone(s), null for public offerings", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "since": "4.13", + "type": "list" + }, + { + "description": "the ID of the vGPU profile to which service offering should be mapped", + "length": 255, + "name": "vgpuprofileid", + "related": "", + "required": false, + "since": "4.21", + "type": "uuid" + }, + { + "description": "true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM", + "length": 255, + "name": "isvolatile", + "required": false, + "type": "boolean" + }, + { + "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", + "length": 255, + "name": "networkrate", + "required": false, + "type": "integer" + }, + { + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "length": 255, + "name": "dynamicscalingenabled", + "required": false, + "since": "4.16", + "type": "boolean" + }, + { + "description": "min iops of the compute offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.4", + "type": "long" + }, + { + "description": "bytes write rate of the disk offering", + "length": 255, + "name": "byteswriterate", + "required": false, + "type": "long" + }, + { + "description": "whether compute offering iops is custom or not", + "length": 255, + "name": "customizediops", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadrate", + "required": false, + "type": "long" + }, + { + "description": "The display text of the service offering, defaults to 'name'.", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "the CPU number of the service offering", + "length": 255, + "name": "cpunumber", + "required": false, + "type": "integer" + }, + { + "description": "VMs using this offering require root volume encryption", + "length": 255, + "name": "encryptroot", + "required": false, + "since": "4.18", + "type": "boolean" + }, + { + "description": "burst bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadratemax", + "required": false, + "type": "long" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "byteswriteratemaxlength", + "required": false, + "type": "long" + }, + { + "description": "the host tag for this service offering.", + "length": 255, + "name": "hosttags", + "required": false, + "type": "string" + }, + { + "description": "is this a system vm offering", + "length": 255, + "name": "issystem", + "required": false, + "type": "boolean" + }, + { + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "length": 255, + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopswriteratemaxlength", + "required": false, + "type": "long" + }, + { + "description": "The minimum number of CPUs to be set with Custom Computer Offering", + "length": 255, + "name": "mincpunumber", + "required": false, + "since": "4.13", + "type": "integer" + }, + { + "description": "Whether service offering size is custom or not", + "length": 255, + "name": "customized", + "required": false, + "since": "4.13", + "type": "boolean" + }, + { + "description": "the HA for the service offering", + "length": 255, + "name": "offerha", + "required": false, + "type": "boolean" + }, + { + "description": "The minimum memory size of the custom service offering in MB", + "length": 255, + "name": "minmemory", + "required": false, + "since": "4.13", + "type": "integer" + }, + { + "description": "the storage type of the service offering. Values are local and shared.", + "length": 255, + "name": "storagetype", + "required": false, + "type": "string" + }, + { + "description": "the tags for this service offering.", + "length": 255, + "name": "tags", + "required": false, + "type": "string" + }, + { + "description": "the name of the service offering", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "burst bytes write rate of the disk offering", + "length": 255, + "name": "byteswriteratemax", + "required": false, + "type": "long" + }, + { + "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", + "length": 255, + "name": "systemvmtype", + "required": false, + "type": "string" + }, + { + "description": "Whether to cleanup instance and its associated resource from database upon expunge of the instance", + "length": 255, + "name": "purgeresources", + "required": false, + "since": "4.20", + "type": "boolean" + }, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "length": 255, + "name": "provisioningtype", + "required": false, + "type": "string" + }, + { + "description": "burst io requests write rate of the disk offering", + "length": 255, + "name": "iopswriteratemax", + "required": false, + "type": "long" + }, + { + "description": "Whether to enable GPU display for this service offering. This is applicable only when passed with vGPU profile. Defaults to false.", + "length": 255, + "name": "gpudisplay", + "required": false, + "since": "4.21", + "type": "boolean" + }, + { + "description": "the ID of the containing domain(s), null for public offerings", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "list" + }, + { + "description": "details for planner, used to store specific parameters", + "length": 255, + "name": "serviceofferingdetails", + "required": false, + "type": "map" + }, + { + "description": "The maximum number of CPUs to be set with Custom Computer Offering", + "length": 255, + "name": "maxcpunumber", + "required": false, + "since": "4.13", + "type": "integer" + }, + { + "description": "io requests read rate of the disk offering", + "length": 255, + "name": "iopsreadrate", + "required": false, + "type": "long" + }, + { + "description": "Number of days instance is leased for.", + "length": 255, + "name": "leaseduration", + "required": false, + "since": "4.21.0", + "type": "integer" + }, + { + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "length": 255, + "name": "diskofferingstrictness", + "required": false, + "since": "4.17", + "type": "boolean" + }, + { + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "length": 255, + "name": "hypervisorsnapshotreserve", + "required": false, + "since": "4.4", + "type": "integer" + }, + { + "description": "the ID of the disk offering to which service offering should be mapped", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "since": "4.17", + "type": "uuid" + }, + { + "description": "For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz.\nFor the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the VM will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest VMs. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.", + "length": 255, + "name": "cpuspeed", + "required": false, + "type": "integer" + }, + { + "description": "restrict the CPU usage to committed service offering", + "length": 255, + "name": "limitcpuuse", + "required": false, + "type": "boolean" + }, + { + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "length": 255, + "name": "storagepolicy", + "related": "", + "required": false, + "since": "4.15", + "type": "uuid" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopsreadratemaxlength", + "required": false, + "type": "long" + } + ], + "related": "updateServiceOffering,listServiceOfferings", + "response": [ + { + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" + }, + { + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" + }, + { + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" + }, + { + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" + }, + { + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "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 ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the date this service offering was created", + "name": "created", + "type": "date" + }, + { + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "state of the service offering", + "name": "state", + "type": "string" + }, + { + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" + }, + { + "description": "Action to be taken once lease is over", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the host tag for the service offering", + "name": "hosttags", + "type": "string" + }, + { + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" + }, + {}, + { + "description": "the id of the service offering", + "name": "id", + "type": "string" + }, + { + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" + }, + { + "description": "Instance lease duration (in days) for service offering", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the memory in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "type": "boolean" + }, + { + "description": "whether GPU device is used for display or not ", + "name": "gpudisplay", + "type": "boolean" + }, + { + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" + }, + { + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" + }, + { + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" + }, + { + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" + }, + { + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" + }, + { + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" + }, + { + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" + }, + {}, + { + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" + }, + { + "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", + "name": "isvolatile", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" + }, + { + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" + }, + { + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" + }, + { + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the count of GPUs to attach ", + "name": "gpucount", + "type": "integer" + }, + { + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the tags for the service offering", + "name": "storagetags", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the name of the service offering", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + } + ] + }, + { + "description": "Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.", + "isasync": false, + "name": "assignVirtualMachine", + "params": [ + { + "description": "account name of the new VM owner.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group.", + "length": 255, + "name": "securitygroupids", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "an optional project for the new VM owner.", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.", + "length": 255, + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "list" + }, + { + "description": "domain id of the new VM owner.", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "id of the VM to be moved", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "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 user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "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" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + } + ], + "type": "set" + }, + {}, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "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" + } + ], + "type": "set" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "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 group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "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": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + {}, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "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": "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": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists virtual machines on a unmanaged host", + "isasync": false, + "name": "listVmsForImport", + "params": [ + { + "description": "the password for the host", + "length": 255, + "name": "password", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "hypervisor type of the host", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the host name or IP address", + "length": 255, + "name": "host", + "required": true, + "type": "string" + }, + { + "description": "the username for the host", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "related": "listVmwareDcVms,listUnmanagedInstances", + "response": [ + { + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ + { + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", + "type": "string" + }, + { + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorehost", + "type": "string" + }, + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + }, + { + "description": "the file path of the disk image", + "name": "imagepath", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", + "type": "string" + }, + { + "description": "the operating system ID of the virtual machine", + "name": "osid", + "type": "string" + }, + { + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", + "type": "string" + }, + { + "description": "the power state of the virtual machine", + "name": "powerstate", + "type": "string" + }, + { + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" + }, + {}, + { + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", + "type": "string" + }, + { + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the list of nics associated with the virtual machine", + "name": "nic", + "response": [ + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + } + ], + "type": "set" + }, + {}, + { + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "indicates the boot type", + "name": "boottype", + "type": "string" + }, + { + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "indicates the boot mode", + "name": "bootmode", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "configures a netscaler load balancer device", + "isasync": true, + "name": "configureNetscalerLoadBalancer", + "params": [ + { + "description": "true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall", + "length": 255, + "name": "inline", + "required": false, + "type": "boolean" + }, + { + "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", + "length": 255, + "name": "lbdevicededicated", + "required": false, + "type": "boolean" + }, + { + "description": "Netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", + "required": true, + "type": "uuid" + }, + { + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "length": 255, + "name": "podids", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "list" + }, + { + "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", + "length": 255, + "name": "lbdevicecapacity", + "required": false, + "type": "long" + } + ], + "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", + "response": [ + { + "description": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" + }, + { + "description": "device state", + "name": "lbdevicestate", + "type": "string" + }, + { + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" + }, + { + "description": "device name", + "name": "lbdevicename", + "type": "string" + }, + { + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" + }, + {}, + { + "description": "the private interface of the load balancer", + "name": "privateinterface", + "type": "string" + }, + { + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" + }, + { + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", + "type": "string" + }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" + }, + {}, + { + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" + }, + { + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + } + ] + }, + { + "description": "delete Tungsten-Fabric service group", + "isasync": true, + "name": "deleteTungstenFabricServiceGroup", + "params": [ + { + "description": "the uuid of Tungsten-Fabric service group", + "length": 255, + "name": "servicegroupuuid", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "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": "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": "Adds a object storage pool", + "isasync": false, + "name": "addObjectStoragePool", + "params": [ + { + "description": "the total size of the object store in GiB. Used for tracking capacity and sending alerts", + "length": 255, + "name": "size", + "required": false, + "since": "4.21", + "type": "long" + }, + { + "description": "the tags for the storage pool", + "length": 255, + "name": "tags", + "required": false, + "type": "string" + }, + { + "description": "the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "the name for the object store", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the URL for the object store", + "length": 2048, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "the object store provider name", + "length": 255, + "name": "provider", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the object store", + "name": "id", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the object store", + "name": "name", + "type": "string" + }, + { + "description": "the total size of the object store", + "name": "storagetotal", + "type": "long" + }, + { + "description": "the object store currently used size", + "name": "storageused", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the url of the object store", + "name": "url", + "type": "string" + }, + { + "description": "the provider name of the object store", + "name": "providername", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "the allocated size of the object store", + "name": "storageallocated", + "type": "long" + } + ], + "since": "4.19.0" + }, + { + "description": "Deletes user from the project", + "isasync": true, + "name": "deleteUserFromProject", + "params": [ + { + "description": "Id of the user to be removed from the project", + "length": 255, + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" + }, + { + "description": "ID of the project to remove the user from", + "length": 255, + "name": "projectid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Deletes a Network Service Provider.", + "isasync": true, + "name": "deleteNetworkServiceProvider", + "params": [ + { + "description": "the ID of the network service provider", + "length": 255, + "name": "id", + "related": "listTrafficTypes", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "List network devices", + "isasync": false, + "name": "listNetworkDevice", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", + "length": 255, + "name": "networkdevicetype", + "required": false, + "type": "string" + }, + { + "description": "parameters for network device", + "length": 255, + "name": "networkdeviceparameterlist", + "required": false, + "type": "map" + } + ], + "related": "addNetworkDevice", + "response": [ + { + "description": "the ID of the network device", + "name": "id", + "type": "string" + }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Lists Project roles in CloudStack", + "isasync": false, + "name": "listProjectRoles", + "params": [ + { + "description": "List project role by project ID.", + "length": 255, + "name": "projectid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List project role by project role name.", + "length": 255, + "name": "name", + "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": "List project role by project role ID.", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" + } + ], + "related": "updateProjectRole", + "response": [ + { + "description": "the id of the project", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "id", + "type": "string" + }, + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the name of the role", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the description of the role", + "name": "description", + "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.15.0" + }, + { + "description": "Removes an OpenDyalight controler", + "isasync": true, + "name": "deleteOpenDaylightController", + "params": [ + { + "description": "OpenDaylight Controller ID", + "length": 255, + "name": "id", + "related": "deleteOpenDaylightController", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the name assigned to the controller", + "name": "name", + "type": "string" + }, + { + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the url of the controller api", + "name": "url", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "device id of the controller", + "name": "id", + "type": "string" + }, + { + "description": "the username to authenticate to the controller", + "name": "username", + "type": "string" + }, + {} + ] + }, + { + "description": "Updates attributes of a template.", + "isasync": false, + "name": "updateTemplate", + "params": [ + { + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" + }, + { + "description": "Force OS type update. Warning: Updating OS type will update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.", + "length": 255, + "name": "forceupdateostype", + "required": false, + "since": "4.21", + "type": "boolean" + }, + { + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "the ID of the image file", + "length": 255, + "name": "id", + "related": "listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the image file", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the ID of the OS type that best represents the OS of this image.", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" + }, + { + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" + }, + { + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" + }, + { + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" + }, + { + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" + }, + { + "description": "the format for the image", + "length": 255, + "name": "format", + "required": false, + "type": "string" + }, + { + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" + }, + { + "description": "indicates that the template can be used for deployment of CKS clusters", + "length": 255, + "name": "forcks", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "true if the image supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" + }, + { + "description": "true if the template type is routing i.e., if template is used to deploy router", + "length": 255, + "name": "isrouting", + "required": false, + "type": "boolean" + }, + { + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "since": "4.20.0", + "type": "string" + }, + { + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "length": 255, + "name": "templatetype", + "required": false, + "type": "string" + } + ], + "related": "listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "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": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + {}, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + {}, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + {}, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "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": "Creates a VLAN IP range.", + "isasync": false, + "name": "createVlanIpRange", + "params": [ + { + "description": "Provider name for which the IP range is reserved for", + "length": 255, + "name": "provider", + "required": false, + "since": "4.21.0", + "type": "string" + }, + { + "description": "the physical network id", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "true if VLAN is of Virtual type, false if Direct", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" + }, + { + "description": "domain ID of the account owning a VLAN", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" + }, + { + "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the beginning IPv6 address in the IPv6 network range", + "length": 255, + "name": "startipv6", + "required": false, + "type": "string" + }, + { + "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", + "length": 255, + "name": "ip6gateway", + "required": false, + "type": "string" + }, + { + "description": "the netmask of the VLAN IP range", + "length": 255, + "name": "netmask", + "required": false, + "type": "string" + }, + { + "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "the Zone ID of the VLAN IP range", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the gateway of the VLAN IP range", + "length": 255, + "name": "gateway", + "required": false, + "type": "string" + }, + { + "description": "the ending IPv6 address in the IPv6 network range", + "length": 255, + "name": "endipv6", + "required": false, + "type": "string" + }, + { + "description": "the CIDR of IPv6 network, must be at least /64", + "length": 255, + "name": "ip6cidr", + "required": false, + "type": "string" + }, + { + "description": "the beginning IP address in the VLAN IP range", + "length": 255, + "name": "startip", + "required": false, + "type": "string" + }, + { + "description": "true if IP range is set to system vms, false if not", + "length": 255, + "name": "forsystemvms", + "required": false, + "type": "boolean" + }, + { + "description": "the ending IP address in the VLAN IP range", + "length": 255, + "name": "endip", + "required": false, + "type": "string" + } + ], + "related": "updateVlanIpRange", + "response": [ + { + "description": "the domain name of the VLAN IP range", + "name": "domain", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" + }, + {}, + { + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", + "type": "string" + }, + { + "description": "the description of the VLAN IP range", + "name": "description", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the cidr of the VLAN IP range", + "name": "cidr", + "type": "string" + }, + { + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the VLAN IP range", + "name": "id", + "type": "string" + }, + { + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + {}, + { + "description": "the project id of the vlan range", + "name": "projectid", + "type": "string" + }, + { + "description": "the Pod name for the VLAN IP range", + "name": "podname", + "type": "string" + }, + { + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", + "type": "string" + }, + { + "description": "the domain ID of the VLAN IP range", + "name": "domainid", + "type": "string" + }, + { + "description": "the end ip of the VLAN IP range", + "name": "endip", + "type": "string" + }, + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the network id of vlan range", + "name": "networkid", + "type": "string" + }, + { + "description": "the account of the VLAN IP range", + "name": "account", + "type": "string" + }, + { + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" + }, + { + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "the start ip of the VLAN IP range", + "name": "startip", + "type": "string" + }, + { + "description": "the project name of the vlan range", + "name": "project", + "type": "string" + }, + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "indicates to which provider the IP range is dedicated to", + "name": "provider", + "type": "string" + } + ] + }, + { + "description": "Updates site to site vpn connection", + "isasync": true, + "name": "updateVpnConnection", + "params": [ + { + "description": "id of vpn connection", + "length": 255, + "name": "id", + "related": "updateVpnConnection", + "required": true, + "type": "uuid" + }, + { + "description": "an optional field, whether to the display the vpn to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "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" + } + ], + "related": "", + "response": [ + { + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" + }, + { + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" + }, + { + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" + }, + { + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" + }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the project id", + "name": "projectid", + "type": "string" + }, + { + "description": "State of vpn connection", + "name": "state", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the owner", + "name": "account", + "type": "string" + }, + { + "description": "the connection ID", + "name": "id", + "type": "string" + }, + { + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" + }, + { + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + { + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, + {}, + { + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" + }, + { + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "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": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "the public IP address", + "name": "publicip", + "type": "string" + } + ], + "since": "4.4" + }, + { + "description": "lists network that are using Palo Alto firewall device", + "isasync": false, + "name": "listPaloAltoFirewallNetworks", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "palo alto balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "response": [ + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the id of the network", + "name": "id", + "type": "string" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "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 network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "state of the network", + "name": "state", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + {}, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", + "type": "string" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "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 service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "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" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the owner of the network", + "name": "account", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + } + ] + }, + { + "description": "Get the path associated with the provided volume UUID", + "isasync": false, + "name": "getPathForVolume", + "params": [ + { + "description": "CloudStack Volume UUID", + "length": 255, + "name": "volumeid", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The path field for the volume", + "name": "path", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ] + }, + { + "description": "Lists management servers.", + "isasync": false, + "name": "listManagementServers", + "params": [ + { + "description": "the name of the management server", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the id of the management server", + "length": 255, + "name": "id", + "related": "listManagementServers", + "required": false, + "type": "uuid" + }, + { + "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": "Whether to return the management server peers or not. By default, the management server peers will not be returned.", + "length": 255, + "name": "peers", + "required": false, + "since": "4.20.1.0", + "type": "boolean" + } + ], + "related": "", + "response": [ + { + "description": "the java distribution name running the management server process", + "name": "javadistribution", + "type": "string" + }, + { + "description": "the IP Address for this Management Server", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the last agents this Management Server is responsible for, before shutdown or preparing for maintenance", + "name": "lastagents", + "type": "list" + }, + { + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" + }, + {}, + { + "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", + "name": "serviceip", + "type": "string" + }, + {}, + { + "description": "the version of the management server", + "name": "version", + "type": "string" + }, + { + "description": "the ID of the management server", + "name": "id", + "type": "string" + }, + { + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", + "type": "string" + }, + { + "description": "the version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" + }, + { + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", + "type": "string" + }, + { + "description": "the number of host agents this Management Server is responsible for", + "name": "agentscount", + "type": "long" + }, + { + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "the number of pending jobs in this Management Server", + "name": "pendingjobscount", + "type": "long" + }, + { + "description": "the name of the management server", + "name": "name", + "type": "string" + }, + { + "description": "the Management Server Peers", + "name": "peers", + "type": "list" + }, + { + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" + }, + { + "description": "the agents this Management Server is responsible for", + "name": "agents", + "type": "list" + } + ] + }, + { + "description": "list Tungsten-Fabric policy", + "isasync": false, + "name": "listTungstenFabricPolicyRule", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric rule", + "length": 255, + "name": "ruleuuid", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "addTungstenFabricPolicyRule", + "response": [ + { + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy action", + "name": "action", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", + "type": "int" + }, + {}, + { + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy name", + "name": "direction", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", + "type": "string" + } + ] + }, + { + "description": "delete Tungsten-Fabric policy", + "isasync": true, + "name": "deleteTungstenFabricPolicy", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the Uuid of Tungsten-Fabric tag type", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" + } + ], + "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": "Updates a vm group", + "isasync": false, + "name": "updateInstanceGroup", + "params": [ + { + "description": "Instance group ID", + "length": 255, + "name": "id", + "related": "updateInstanceGroup", + "required": true, + "type": "uuid" + }, + { + "description": "new instance group name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the project ID of the instance group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the instance group", + "name": "domainid", + "type": "string" + }, + { + "description": "time and date the instance group was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", + "type": "string" + }, + {}, + { + "description": "the account owning the instance group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the instance group", + "name": "id", + "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": "the project name of the instance group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the instance group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the instance group", + "name": "domain", + "type": "string" + } + ] + }, + { + "description": "List the uploaded certificates for direct download templates", + "isasync": false, + "name": "listTemplateDirectDownloadCertificates", + "params": [ + { + "description": "list direct download certificate by ID", + "length": 255, + "name": "id", + "related": "listTemplateDirectDownloadCertificates", + "required": false, + "type": "uuid" + }, + { + "description": "the zone where certificates are uploaded", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "if set to true: include the hosts where the certificate is uploaded to", + "length": 255, + "name": "listhosts", + "required": false, + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the direct download certificate id", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the direct download certificate version", + "name": "version", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the direct download certificate subject", + "name": "subject", + "type": "string" + }, + { + "description": "the direct download certificate issuer", + "name": "validity", + "type": "string" + }, + { + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", + "type": "string" + }, + { + "description": "the direct download certificate issuer", + "name": "issuer", + "type": "string" + }, + { + "description": "the direct download certificate serial num", + "name": "serialnum", + "type": "string" + }, + { + "description": "the zone name where the certificate is uploaded", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the direct download certificate alias", + "name": "alias", + "type": "string" + }, + { + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" + } + ], + "since": "4.17.0" + }, + { + "description": "List ucs manager", + "isasync": false, + "name": "listUcsManagers", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the ucs manager", + "length": 255, + "name": "id", + "related": "listUcsManagers", + "required": false, + "type": "uuid" + }, + { + "description": "the zone id", + "length": 255, + "name": "zoneid", + "related": "listZones", + "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" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of ucs manager", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the zone ID of ucs manager", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the ucs manager", + "name": "id", + "type": "string" + }, + { + "description": "the url of ucs manager", + "name": "url", + "type": "string" + } + ] + }, + { + "description": "Upgrades domain router to a new service offering", + "isasync": false, + "name": "changeServiceForRouter", + "params": [ + { + "description": "The ID of the router", + "length": 255, + "name": "id", + "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" + }, + { + "description": "the service offering ID to apply to the domain router", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + } + ], + "related": "listRouters,listInternalLoadBalancerVMs", + "response": [ + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + {}, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + {}, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + } + ] + }, + { + "description": "Updates the volume.", + "isasync": true, + "name": "updateVolume", + "params": [ + { + "description": "an optional field, whether to the display the volume to the end user or not.", + "length": 255, + "name": "displayvolume", + "required": false, + "type": "boolean" + }, + { + "description": "The path of the volume", + "length": 255, + "name": "path", + "required": false, + "type": "string" + }, + { + "description": "Destination storage pool UUID for the volume", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "since": "4.3", + "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": "new name of the volume", + "length": 255, + "name": "name", + "required": false, + "since": "4.16", + "type": "string" + }, + { + "description": "the ID of the disk volume", + "length": 255, + "name": "id", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "required": false, + "type": "uuid" + }, + { + "description": "The chain info of the volume", + "length": 255, + "name": "chaininfo", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "Set delete protection for the volume. If true, The volume will be protected from deletion. Note: If the volume is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", + "length": 255, + "name": "deleteprotection", + "required": false, + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "The state of the volume", + "length": 255, + "name": "state", + "required": false, + "since": "4.3", + "type": "string" + } + ], + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "response": [ + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "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 account associated with the disk volume", + "name": "account", + "type": "string" + }, + {}, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + } + ] + }, + { + "description": "Lists traffic types of a given physical network.", + "isasync": false, + "name": "listTrafficTypes", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + {}, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Updates account information for the authenticated user", + "isasync": false, + "name": "updateAccount", + "params": [ + { + "description": "New name for the account", + "length": 255, + "name": "newname", + "required": false, + "type": "string" + }, + { + "description": "The UUID of the domain where the account exists", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Current account name", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Details for the account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" + }, + { + "description": "Determines if Api key access for this user is enabled, disabled or inherits the value from its parent, the domain level setting api.key.access", + "length": 255, + "name": "apikeyaccess", + "required": false, + "since": "4.20.1.0", + "type": "string" + }, + { + "description": "Account UUID", + "length": 255, + "name": "id", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "The UUID of the dynamic role to set for the account", + "length": 255, + "name": "roleid", + "related": "createRole,listRoles,updateRole", + "required": false, + "type": "uuid" + }, + { + "description": "Network domain for the account's networks; empty string will update domainName with NULL value", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" + } + ], + "related": "disableAccount,enableAccount,listAccounts", + "response": [ + { + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, + {}, + { + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "the total number of backups available to this account", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", + "type": "string" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", + "type": "string" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" + }, + {}, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the network domain", + "name": "networkdomain", + "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 memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total number of gpus the account can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", + "type": "string" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + } + ] + }, + { + "description": "Adds secondary storage.", + "isasync": false, + "name": "addSecondaryStorage", + "params": [ + { + "description": "the URL for the secondary storage", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "the Zone ID for the secondary storage", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + } + ], + "related": "listSwifts", + "response": [ + { + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + { + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + }, + {}, + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + { + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + } + ] + }, + { + "description": "Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.", + "isasync": false, + "name": "updateVirtualMachine", + "params": [ + { + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", + "required": false, + "since": "4.12", + "type": "string" + }, + { + "description": "instance name of the user vm", + "length": 255, + "name": "instancename", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", + "length": 255, + "name": "name", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "the ID of the userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18", + "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": "user generated name", + "length": 255, + "name": "displayname", + "required": false, + "type": "string" + }, + { + "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "length": 255, + "name": "securitygroupnames", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18", + "type": "map" + }, + { + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "since": "4.16.0", + "type": "string" + }, + { + "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "length": 255, + "name": "dhcpoptionsnetworklist", + "required": false, + "type": "map" + }, + { + "description": "Number of days to lease the instance from now onward. Use -1 to remove the existing lease", + "length": 255, + "name": "leaseduration", + "required": false, + "since": "4.21.0", + "type": "integer" + }, + { + "description": "the ID of the OS type that best represents this VM.", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" + }, + { + "description": "true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" + }, + { + "description": "true if high-availability is enabled for the virtual machine, false otherwise", + "length": 255, + "name": "haenable", + "required": false, + "type": "boolean" + }, + { + "description": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, + "name": "displayvm", + "required": false, + "type": "boolean" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "Set delete protection for the virtual machine. If true, the instance will be protected from deletion. Note: If the instance is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", + "length": 255, + "name": "deleteprotection", + "required": false, + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" + }, + { + "description": "Lease expiry action, valid values are STOP and DESTROY", + "length": 255, + "name": "leaseexpiryaction", + "required": false, + "since": "4.21.0", + "type": "string" + }, + { + "description": "list of security group ids to be applied on the virtual machine.", + "length": 255, + "name": "securitygroupids", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "group of the virtual machine", + "length": 255, + "name": "group", + "required": false, + "type": "string" + } + ], + "related": "createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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" + } + ], + "type": "set" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "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 video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + {}, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + {}, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "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 name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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": "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" + }, + { + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "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 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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "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" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "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": "security group name", + "name": "securitygroupname", + "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" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "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" + }, + { + "description": "tag value", + "name": "value", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "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" + }, + { + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project 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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, - {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the user lastname", - "name": "lastname", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" } ] }, { - "description": "remove Tungsten-Fabric policy", + "description": "Disables an account", "isasync": true, - "name": "removeTungstenFabricPolicy", + "name": "disableAccount", "params": [ { - "description": "the uuid of Tungsten-Fabric network", + "description": "Disables specified account.", "length": 255, - "name": "networkuuid", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "Account id", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, + "name": "id", + "related": "disableAccount,enableAccount,listAccounts", + "required": false, "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "Disables specified account in this domain.", "length": 255, - "name": "policyuuid", + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "If true, only lock the account; else disable the account", + "length": 255, + "name": "lock", "required": true, - "type": "string" + "type": "boolean" } ], - "related": "listTungstenFabricPolicy,applyTungstenFabricPolicy", + "related": "enableAccount,listAccounts", "response": [ - {}, - {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "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 allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", - "type": "string" + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" - } - ] - }, - { - "description": "Lists all available ISO files.", - "isasync": false, - "name": "listIsos", - "params": [ + }, { - "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": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the hypervisor for which to restrict the search", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", - "length": 255, - "name": "isofilter", - "required": false, + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "ID of the storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "since": "4.19", - "type": "uuid" + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" }, { - "description": "list ISO by ID", - "length": 255, - "name": "id", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "type": "uuid" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "true if the ISO is bootable, false otherwise", - "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "ID of the image or image cache store", - "length": 255, - "name": "imagestoreid", - "related": "listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": false, - "since": "4.19", - "type": "uuid" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "list all ISOs by name", - "length": 255, - "name": "name", - "required": false, + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "If set to true, list only unique isos across zones", - "length": 255, - "name": "showunique", - "required": false, - "since": "4.13.2", - "type": "boolean" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "show removed ISOs as well", - "length": 255, - "name": "showremoved", - "required": false, - "type": "boolean" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "true if this ISO is ready to be deployed", - "length": 255, - "name": "isready", - "required": false, - "type": "boolean" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "true if the ISO is publicly available to all users, false otherwise.", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "description": "the id of the account", + "name": "id", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" }, { - "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 total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "flag to display the resource image for the isos", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - } - ], - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", + "description": "the list of acl groups that account belongs to", + "name": "groups", "type": "list" }, { - "description": "the template name", - "name": "name", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "the date this template was created", + "description": "the date when this account was created", "name": "created", "type": "date" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the project name of the template", - "name": "project", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the tag of this template", - "name": "templatetag", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the size of the template", - "name": "size", + "description": "the total number of backups stored by this account", + "name": "backuptotal", "type": "long" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the name of the account", + "name": "name", "type": "string" }, - {}, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "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 total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, - {}, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "the project id of the template", - "name": "projectid", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the domain ID of the user", "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the domain name of the user", "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, + {}, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" }, + {}, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the template ID", - "name": "id", + "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", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" } ] }, { - "description": "Migrate current NFS secondary storages to use object store.", + "description": "Lists domains and provides detailed information for listed domains", "isasync": false, - "name": "updateCloudToUseObjectStore", + "name": "listDomains", "params": [ { - "description": "the URL for the image store", + "description": "List domain by domain ID.", "length": 255, - "name": "url", + "name": "id", + "related": "listDomains,listDomains", + "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", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "List domains by domain level.", + "length": 255, + "name": "level", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "the name for the image store", + "description": "List domain by domain name.", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "the image store provider name", + "description": "", "length": 255, - "name": "provider", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", "length": 255, "name": "details", "required": false, - "type": "map" + "type": "list" + }, + { + "description": "Tag for resource type to return usage", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", + "type": "string" + }, + { + "description": "flag to display the resource icon for domains", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" } ], - "related": "listSwifts,addImageStoreS3,listImageStores", + "related": "listDomains", "response": [ { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the name of the domain", + "name": "name", + "type": "string" + }, + { + "description": "whether the domain has one or more sub-domains", + "name": "haschild", "type": "boolean" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "the total number of backups available to this domain", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the state of the domain", + "name": "state", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of gpus owned by domain", + "name": "gputotal", + "type": "long" + }, + { + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", + "type": "string" + }, + { + "description": "the path of the domain", + "name": "path", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of gpus the domain can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { @@ -95641,465 +124200,703 @@ var preCache = `{ "type": "integer" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", + "type": "string" + }, + { + "description": "the ID of the domain", + "name": "id", "type": "string" }, {}, + {}, { - "description": "the name of the image store", - "name": "name", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" } - ], - "since": "4.3.0" + ] }, { - "description": "Lists autoscale policies.", + "description": "Resets the UserData for virtual machine. The virtual machine must be in a \"Stopped\" state.", "isasync": false, - "name": "listAutoScalePolicies", + "name": "resetUserDataForVirtualMachine", "params": [ { - "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 objects by project; if projectid=-1 lists All VMs", + "description": "an optional project for the virtual machine", "length": 255, "name": "projectid", - "related": "activateProject,suspendProject", + "related": "", "required": false, "type": "uuid" }, { - "description": "", + "description": "The ID of the virtual machine", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "id", + "related": "createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the userdata", "length": 255, - "name": "isrecursive", + "name": "userdataid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the condition of the policy", - "length": 255, - "name": "conditionid", - "related": "", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "the name of the autoscale policy", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "name", + "name": "userdatadetails", "required": false, - "since": "4.18.0", + "type": "map" + } + ], + "related": "createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the autoscale policy", - "length": 255, - "name": "id", - "related": "listAutoScalePolicies", - "required": false, - "type": "uuid" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the ID of the autoscale vm group", - "length": 255, - "name": "vmgroupid", - "related": "listAutoScaleVmGroups", - "required": false, - "type": "uuid" + "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 action to be executed if all the conditions evaluate to true for the specified duration.", - "length": 255, - "name": "action", - "required": false, + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, - {}, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", - "type": "integer" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "name of the autoscale policy", - "name": "name", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the autoscale policy ID", + "description": "the ID of the virtual machine", "name": "id", "type": "string" }, - {}, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" - } - ] - }, - { - "description": "adds baremetal rack configuration text", - "isasync": true, - "name": "addBaremetalRct", - "params": [ + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, { - "description": "http url to baremetal RCT configuration", - "length": 255, - "name": "baremetalrcturl", - "required": true, - "type": "object" - } - ], - "related": "", - "response": [ - {}, + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, { - "description": "url", - "name": "url", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, - {}, { - "description": "id of rct", - "name": "id", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" - } - ] - }, - { - "description": "add Tungsten-Fabric network gateway to logical router", - "isasync": true, - "name": "addTungstenFabricNetworkGatewayToLogicalRouter", - "params": [ + }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "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": "Tungsten-Fabric logical router uuid", - "length": 255, - "name": "logicalrouteruuid", - "required": true, + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "Tungsten-Fabric network uuid", - "length": 255, - "name": "networkuuid", - "required": true, + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" - } - ], - "related": "removeTungstenFabricNetworkGatewayFromLogicalRouter", - "response": [ + }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, + {}, { - "description": "Tungsten-Fabric logical router name", - "name": "name", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, - {}, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", "type": "list" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" - } - ] - }, - { - "description": "Updates a role", - "isasync": false, - "name": "updateRole", - "params": [ + }, { - "description": "creates a role with this unique name", - "length": 255, - "name": "name", - "required": false, + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "ID of the role", - "length": 255, - "name": "id", - "related": "importRole,listRoles,updateRole", - "required": true, - "type": "uuid" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "The description of the role", - "length": 255, - "name": "description", - "required": false, + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", - "length": 255, - "name": "type", - "required": false, + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "The description of the role", - "length": 255, - "name": "description", - "required": false, + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" - } - ], - "related": "importRole,listRoles", - "response": [ + }, { - "description": "the ID of the role", - "name": "id", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the type of the role", - "name": "type", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - {}, { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "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 in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the role", - "name": "name", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "list Tungsten-Fabric nic", - "isasync": false, - "name": "listTungstenFabricNic", - "params": [ + }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric nic", - "length": 255, - "name": "nicuuid", - "required": false, + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "Tungsten-Fabric nic uuid", - "name": "uuid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { @@ -96108,277 +124905,489 @@ var preCache = `{ "type": "integer" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, - {}, - { - "description": "Tungsten-Fabric nic name", - "name": "name", - "type": "string" - } - ] - }, - { - "description": "Retrieves VMware DC(s) associated with a zone.", - "isasync": false, - "name": "listVmwareDcs", - "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "Id of the CloudStack zone.", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "addVmwareDc", - "response": [ - {}, + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, { - "description": "The VMware Datacenter name", - "name": "name", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the Zone ID associated with this VMware Datacenter", - "name": "zoneid", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "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" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the 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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "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" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "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": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" + }, + { + "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" + } + ], + "type": "set" }, { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "The VMware Datacenter ID", - "name": "id", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" - } - ] - }, - { - "description": "apply Tungsten-Fabric policy", - "isasync": true, - "name": "applyTungstenFabricPolicy", - "params": [ - { - "description": "the major sequence of Tungsten-Fabric policy", - "length": 255, - "name": "majorsequence", - "required": true, - "type": "integer" - }, - { - "description": "the minor sequence of Tungsten-Fabric policy", - "length": 255, - "name": "minorsequence", - "required": true, - "type": "integer" - }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" }, { - "description": "the uuid of network", - "length": 255, - "name": "networkuuid", - "required": true, + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": true, - "type": "string" - } - ], - "related": "listTungstenFabricPolicy", - "response": [ - {}, - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, - {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" - } - ] - }, - { - "description": "Lists zones", - "isasync": false, - "name": "listZones", - "params": [ - { - "description": "the IDs of the zones, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "createZone,listZones,listZones", - "required": false, - "since": "4.19.0", - "type": "list" }, { - "description": "flag to display the resource image for the zones", - "length": 255, - "name": "showicon", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "List zones by resource tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "since": "4.3", - "type": "map" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the name of the zone", - "length": 255, - "name": "name", - "required": false, + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", - "length": 255, - "name": "available", - "required": false, - "type": "boolean" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the ID of the domain associated with the zone", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the network type of the zone that the virtual machine belongs to", - "length": 255, - "name": "networktype", - "required": false, - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the zone", - "length": 255, - "name": "id", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "flag to display the capacity of the zones", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" - } - ], - "related": "createZone,listZones", - "response": [ - { - "description": "the list of resource tags associated with zone.", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -96387,28 +125396,23 @@ var preCache = `{ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -96417,1049 +125421,364 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { "description": "id of the resource", "name": "resourceid", "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" } ], "type": "set" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" - }, - { - "description": "the display text of the zone", - "name": "displaytext", - "type": "string" - }, - { - "description": "Zone description", - "name": "description", - "type": "string" - }, - { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" - }, - { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the Cluster name", - "name": "clustername", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the ID of the affinity group", + "name": "id", + "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], - "type": "list" - }, - {}, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the type of the zone - core or edge", - "name": "type", - "type": "string" - }, - { - "description": "Zone id", - "name": "id", - "type": "string" - }, - { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" - }, - { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" - }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" - }, - {}, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" - }, - { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" - }, - { - "description": "Zone name", - "name": "name", - "type": "string" - }, - { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" - }, - { - "description": "the first DNS for the Zone", - "name": "dns1", - "type": "string" - } - ] - }, - { - "description": "Lists remote access vpns", - "isasync": false, - "name": "listRemoteAccessVpns", - "params": [ - { - "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": "public ip address id of the vpn server", - "length": 255, - "name": "publicipid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", - "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": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list remote access VPNs for certain network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.3", - "type": "uuid" - }, - { - "description": "Lists remote access vpn rule with the specified ID", - "length": 255, - "name": "id", - "related": "listRemoteAccessVpns,updateRemoteAccessVpn", - "required": false, - "since": "4.3", - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - } - ], - "related": "updateRemoteAccessVpn", - "response": [ - { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", - "type": "string" - }, - { - "description": "the range of ips to allocate to the clients", - "name": "iprange", - "type": "string" - }, - { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" - }, - { - "description": "the id of the remote access vpn", - "name": "id", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the ipsec preshared key", - "name": "presharedkey", - "type": "string" - }, - {}, - { - "description": "the public ip address of the vpn server", - "name": "publicip", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "the public ip address of the vpn server", - "name": "publicipid", - "type": "string" - }, - { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "type": "string" - }, - { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Removes a public IP address from quarantine. Only IPs in active quarantine can be removed.", - "isasync": false, - "name": "removeQuarantinedIp", - "params": [ - { - "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - }, - { - "description": "The ID of the public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", - "length": 255, - "name": "id", - "related": "listQuarantinedIps,updateQuarantinedIp,removeQuarantinedIp", - "required": false, - "type": "uuid" - }, - { - "description": "The reason for removing the public IP address from quarantine prematurely.", - "length": 255, - "name": "removalreason", - "required": true, - "type": "string" - } - ], - "related": "listQuarantinedIps,updateQuarantinedIp", - "response": [ - { - "description": "The public IP address in quarantine.", - "name": "ipaddress", - "type": "string" - }, - { - "description": "When the quarantine was removed.", - "name": "removed", - "type": "date" - }, - {}, - { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" - }, - { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", - "type": "string" - }, - { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "type": "set" }, { - "description": "End date for the quarantine.", - "name": "enddate", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", "type": "date" - }, - { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "ID of the quarantine process.", - "name": "id", - "type": "string" - }, - { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", - "type": "string" } ], - "since": "4.19" - }, - { - "description": "Deletes a network ACL", - "isasync": true, - "name": "deleteNetworkACLList", - "params": [ - { - "description": "the ID of the network ACL", - "length": 255, - "name": "id", - "related": "createNetworkACLList", - "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.18.0" }, { - "description": "Removes secondary IP from the NIC.", + "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", "isasync": true, - "name": "removeIpFromNic", + "name": "deleteTemplate", "params": [ { - "description": "the ID of the secondary ip address to nic", + "description": "the ID of the template", "length": 255, "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "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": "Creates a system virtual-machine that implements network services", - "isasync": true, - "name": "createServiceInstance", - "params": [ - { - "description": "Project ID for the service instance", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, - { - "description": "The service offering ID that defines the resources consumed by the service appliance", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "related": "listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" }, { - "description": "Availability zone for the service instance", + "description": "the ID of zone of the template", "length": 255, "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "The template ID that specifies the image for the service appliance", - "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - }, - { - "description": "The right (outside) network ID for the service instance", - "length": 255, - "name": "rightnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - }, - { - "description": "An optional account for the virtual machine. Must be used with domainId.", + "description": "Force delete a template.", "length": 255, - "name": "account", + "name": "forced", "required": false, - "type": "string" - }, - { - "description": "The left (inside) network for service instance", - "length": 255, - "name": "leftnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "since": "4.9+", + "type": "boolean" }, { - "description": "The name of the service instance", + "description": "Necessary if the template's type is system.", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "issystem", + "required": false, + "since": "4.20.0", + "type": "boolean" } ], - "related": "", "response": [ - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - {}, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "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 domain in which the virtual machine exists", - "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 virtual machine", - "name": "name", - "type": "string" - } - ] - }, - { - "description": "Releases a Public IP range back to the system pool", - "isasync": false, - "name": "releasePublicIpRange", - "params": [ - { - "description": "the id of the Public IP range", - "length": 255, - "name": "id", - "related": "dedicatePublicIpRange", - "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" - } - ] - }, - { - "description": "lists network that are using a netscaler load balancer device", - "isasync": false, - "name": "listNetscalerLoadBalancerNetworks", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "netscaler load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter", - "required": true, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", - "response": [ - { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - {}, - { - "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": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "the owner of the network", - "name": "account", - "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Lists all network ACLs", + "isasync": false, + "name": "listNetworkACLLists", + "params": [ { - "description": "The routing mode of network offering", - "name": "ip6routing", - "type": "string" + "description": "Lists network ACL with the specified ID.", + "length": 255, + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", + "required": false, + "type": "uuid" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "list network ACLs by specified name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" + "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 first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "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": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "list network ACLs by VPC ID", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "list network ACLs by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "createNetworkACLList", + "response": [ { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", + "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "is ACL for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "Description of the ACL", + "name": "description", "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "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" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the network", + "description": "the Name of the ACL", "name": "name", "type": "string" }, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "the type of the network", - "name": "type", + "description": "the ID of the ACL", + "name": "id", "type": "string" }, + {} + ] + }, + { + "description": "Archives (moves) a snapshot on primary storage to secondary storage", + "isasync": true, + "name": "archiveSnapshot", + "params": [ { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "The ID of the snapshot", + "length": 255, + "name": "id", + "related": "copySnapshot,archiveSnapshot,listSnapshots", + "required": true, + "type": "uuid" + } + ], + "related": "copySnapshot,listSnapshots", + "response": [ + {}, + { + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "the list of resource tags associated", "name": "tags", "response": [ { @@ -97468,13 +125787,8 @@ var preCache = `{ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -97488,13 +125802,13 @@ var preCache = `{ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -97503,8 +125817,18 @@ var preCache = `{ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -97513,278 +125837,222 @@ var preCache = `{ "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, + {}, { - "description": "the network domain", - "name": "networkdomain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", + "type": "long" }, { - "description": "state of the network", - "name": "state", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "the id of the network", - "name": "id", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the project name of the snapshot", + "name": "project", + "type": "string" } ] }, { - "description": "create Tungsten-Fabric public network", - "isasync": false, - "name": "createTungstenFabricPublicNetwork", + "description": "Updates site to site vpn local gateway", + "isasync": true, + "name": "updateVpnGateway", "params": [ { - "description": "the ID of zone", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", + "name": "fordisplay", + "required": false, + "since": "4.4", "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": "Starts a system virtual machine.", - "isasync": true, - "name": "startSystemVm", - "params": [ - { - "description": "The ID of the system virtual machine", + "description": "id of customer gateway", "length": 255, "name": "id", - "related": "migrateSystemVm,startSystemVm", + "related": "updateVpnGateway", "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" } ], - "related": "migrateSystemVm", + "related": "", "response": [ { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" - }, - { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, + {}, { - "description": "the name of the system VM", - "name": "name", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { @@ -97793,523 +126061,478 @@ var preCache = `{ "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - {}, - { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, {}, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the project id", + "name": "projectid", "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 domain id of the owner", + "name": "domainid", + "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the project name", + "name": "project", "type": "string" - }, + } + ], + "since": "4.4" + }, + { + "description": "Releases a dedicated guest vlan range to the system", + "isasync": true, + "name": "releaseDedicatedGuestVlanRange", + "params": [ + { + "description": "the ID of the dedicated guest vlan range", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Deletes security group", + "isasync": false, + "name": "deleteSecurityGroup", + "params": [ { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "The ID of the security group. Mutually exclusive with name parameter", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "the project of the security group", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "The ID of the security group. Mutually exclusive with id parameter", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the account of the security group. Must be specified with domain ID", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" - }, + "description": "the domain ID of account owning the security group", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + } + ], + "response": [ { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {} + ] + }, + { + "description": "Creates a customized GUI theme for a set of Common Names (fixed or wildcard), a set of domain UUIDs, and/or a set of account UUIDs.", + "isasync": false, + "name": "createGuiTheme", + "params": [ { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "Defines whether the subdomains of the informed domains are considered. Default value is false.", + "length": 255, + "name": "recursivedomains", + "required": false, + "type": "boolean" }, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" + "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "length": 65535, + "name": "domainids", + "required": false, "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "length": 65535, + "name": "commonnames", + "required": false, "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "length": 65535, + "name": "css", + "required": false, "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "length": 65535, + "name": "accountids", + "required": false, "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "length": 65535, + "name": "jsonconfiguration", + "required": false, "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "A description for the theme.", + "length": 4096, + "name": "description", + "required": false, "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "A name to identify the theme.", + "length": 2048, + "name": "name", + "required": true, "type": "string" } - ] - }, - { - "description": "Lists host HA resources", - "isasync": false, - "name": "listHostHAResources", - "params": [ - { - "description": "List by host ID", - "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" - } ], - "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", + "related": "", "response": [ + { + "description": "Name of the GUI theme.", + "name": "name", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "When the GUI theme was created.", + "name": "created", + "type": "date" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "accountids", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "domainids", + "type": "string" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "ID of the custom GUI theme.", + "name": "id", "type": "string" }, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "Whether to consider the subdomains of the informed domain IDs.", + "name": "recursivedomains", + "type": "boolean" }, { - "description": "operation status", - "name": "status", + "description": "Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.", + "name": "ispublic", "type": "boolean" - } - ], - "since": "4.11" - }, - { - "description": "Lists supported methods of network isolation", - "isasync": false, - "name": "listNetworkIsolationMethods", - "params": [ + }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "When the GUI theme was removed.", + "name": "removed", + "type": "date" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "name": "commonnames", "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "css", "type": "string" }, {}, { - "description": "Network isolation method name", - "name": "name", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "jsonconfiguration", + "type": "string" + }, + { + "description": "Description of the GUI theme.", + "name": "description", "type": "string" } ], - "since": "4.2.0" + "since": "4.21.0.0" }, { - "description": "Registers an existing VNF template into the CloudStack cloud. ", - "isasync": false, - "name": "registerVnfTemplate", + "description": "Import an unmanaged volume from a storage pool on a host into CloudStack", + "isasync": true, + "name": "importVolume", "params": [ { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - }, - { - "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", - "length": 255, - "name": "vnfdetails", - "required": false, - "type": "map" - }, - { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "an optional account for the volume. Must be used with domainId.", "length": 255, - "name": "directdownload", + "name": "account", "required": false, - "type": "boolean" - }, - { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" - }, - { - "description": "true if the template or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" - }, - { - "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", + "description": "the ID of the storage pool", "length": 255, - "name": "vnfnics", - "required": false, - "type": "map" + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": true, + "type": "uuid" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "import volume to the domain specified", "length": 255, - "name": "ispublic", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", + "description": "import volume for the project", "length": 255, - "name": "ostypeid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, - "type": "string" - }, - { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "the ID of the disk offering linked to the volume", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "diskofferingid", + "related": "", "required": false, "type": "uuid" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "the path of the volume", "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" + "name": "path", + "required": true, + "type": "string" }, { - "description": "Register template for the project", + "description": "the name of the volume. If not set, it will be set to the path of the volume.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "name", "required": false, - "type": "uuid" - }, + "type": "string" + } + ], + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "response": [ { - "description": "the ID of the zone the template is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", - "length": 255, - "name": "zoneids", - "related": "createZone,listZones", - "required": false, - "type": "list" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", - "length": 255, - "name": "deployasis", - "required": false, - "since": "4.15.1", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "the name of the template", - "length": 255, - "name": "name", - "required": true, + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "true if this template requires HVM", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", - "length": 255, - "name": "templatetype", - "required": false, - "since": "4.19.0", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + {}, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "32 or 64 bits support. 64 by default", - "length": 255, - "name": "bits", - "required": false, - "type": "integer" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", - "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", - "length": 255, - "name": "format", - "required": true, + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" - } - ], - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ + }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the domain associated with the disk volume", + "name": "domain", "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", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "the path of the volume", + "name": "path", "type": "string" }, { @@ -98317,18 +126540,18 @@ var preCache = `{ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -98337,493 +126560,589 @@ var preCache = `{ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "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 account name to which the template belongs", - "name": "account", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "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 read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", + "description": "the date the disk volume was created", + "name": "created", "type": "date" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the status of the template", - "name": "status", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, + {}, { - "description": "the template name", - "name": "name", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" } ], - "since": "4.19.0" + "since": "4.19.1" }, { - "description": "Lists VM stats", - "isasync": false, - "name": "listVirtualMachinesUsageHistory", + "description": "Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it.", + "isasync": true, + "name": "createTemplate", "params": [ { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "true if this template is a public template, false otherwise", "length": 255, - "name": "enddate", + "name": "ispublic", "required": false, - "type": "date" + "type": "boolean" }, { - "description": "the ID of the virtual machine.", + "description": "the tag for this template.", "length": 255, - "name": "id", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "templatetag", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "keyword", + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", "length": 255, - "name": "startdate", + "name": "volumeid", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "", + "description": "the name of the template", "length": 255, - "name": "pagesize", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "length": 255, + "name": "isfeatured", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id.", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "ids", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "sshkeyenabled", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "", + "description": "32 or 64 bit", "length": 255, - "name": "page", + "name": "bits", "required": false, "type": "integer" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", + "description": "Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal", "length": 255, - "name": "name", + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "required": false, - "type": "string" - } - ], - "related": "listSystemVmsUsageHistory", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "type": "uuid" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "The display text of the template, defaults to the 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the list of VM stats", - "name": "stats", - "type": "list" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the zone for the template. Can be specified with snapshot only", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "since": "4.19.0", + "type": "uuid" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the ID of the OS Type that best represents the OS of this template.", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": true, + "type": "uuid" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "create template for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, - {} - ], - "since": "4.17" - }, - { - "description": "list Tungsten-Fabric firewall policy", - "isasync": false, - "name": "listTungstenFabricFirewallPolicy", - "params": [ { - "description": "", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "pagesize", + "name": "passwordenabled", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", - "length": 255, - "name": "firewallpolicyuuid", + "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", + "length": 2048, + "name": "url", "required": false, "type": "string" }, { - "description": "", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "since": "4.19.0", + "type": "uuid" }, { - "description": "List by keyword", + "description": "true if the template requires HVM, false otherwise", "length": 255, - "name": "keyword", + "name": "requireshvm", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of zone", + "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "snapshotid", + "related": "copySnapshot,listSnapshots", "required": false, "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64. Defaults to x86_64", "length": 255, - "name": "applicationpolicysetuuid", + "name": "arch", "required": false, + "since": "4.20.2", "type": "string" } ], - "related": "", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "Tungsten-Fabric firewall policy name", - "name": "name", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "Tungsten-Fabric firewall policy uuid", - "name": "uuid", + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "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 name of the zone for this template", + "name": "zonename", + "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": "list Tungsten-Fabric firewall rule", - "name": "firewallrule", - "type": "list" + "description": "checksum of the template", + "name": "checksum", + "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": "Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host.", - "isasync": true, - "name": "declareHostAsDegraded", - "params": [ { - "description": "host ID", - "length": 255, - "name": "id", - "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "response": [ + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { @@ -98832,638 +127151,627 @@ var preCache = `{ "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "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 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" - }, - { - "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 no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, - {}, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "events available for the host", - "name": "events", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, + {}, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the ID of the host", - "name": "id", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the project name of the template", + "name": "project", "type": "string" - }, + } + ] + }, + { + "description": "Restores an existing stopped or deleted VM using a VM backup", + "isasync": true, + "name": "restoreBackup", + "params": [ { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "ID of the backup", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ], + "since": "4.14.0" + }, + { + "description": "Lists dedicated clusters.", + "isasync": false, + "name": "listDedicatedClusters", + "params": [ { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "list dedicated clusters by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the name of the account associated with the cluster. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the ID of the domain associated with the cluster", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "the admin that annotated this host", - "name": "username", + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the ID of the cluster", + "name": "clusterid", "type": "string" }, + {}, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the Account ID of the cluster", + "name": "accountid", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the name of the cluster", + "name": "clustername", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the domain ID of the cluster", + "name": "domainid", + "type": "string" }, - {}, { - "description": "the host version", - "name": "version", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ], - "since": "4.16.0.0" + ] }, { - "description": "Creates a Kubernetes cluster", + "description": "Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself.", "isasync": true, - "name": "createKubernetesCluster", + "name": "uploadCustomCertificate", "params": [ { - "description": "type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.", - "length": 255, - "name": "clustertype", - "required": false, - "since": "4.19.0", - "type": "string" - }, - { - "description": "root disk size in GB for each node", + "description": "An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3", "length": 255, - "name": "noderootdisksize", + "name": "id", "required": false, - "type": "long" + "type": "integer" }, { - "description": "name for the Kubernetes cluster", - "length": 255, - "name": "name", + "description": "The certificate to be uploaded.", + "length": 65535, + "name": "certificate", "required": true, "type": "string" }, { - "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", - "length": 255, - "name": "masternodes", - "required": false, - "type": "long" - }, - { - "description": "Kubernetes version with which cluster to be launched", - "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", - "required": false, - "type": "uuid" - }, - { - "description": "number of Kubernetes cluster control nodes, default is 1", + "description": "DNS domain suffix that the certificate is granted for.", "length": 255, - "name": "controlnodes", - "required": false, - "type": "long" + "name": "domainsuffix", + "required": true, + "type": "string" }, { - "description": "user name for the docker image private registry", + "description": "A name / alias for the certificate.", "length": 255, - "name": "dockerregistryusername", + "name": "name", "required": false, "type": "string" }, { - "description": "availability zone in which Kubernetes cluster to be launched", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "description": "The private key for the attached certificate.", + "length": 65535, + "name": "privatekey", "required": false, - "type": "uuid" - }, + "type": "string" + } + ], + "related": "", + "response": [ + {}, { - "description": "Deploy cluster for the project", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "URL for the docker image private registry", - "length": 255, - "name": "dockerregistryurl", - "required": false, + "description": "message of the certificate upload operation", + "name": "message", "type": "string" }, { - "description": "description for the Kubernetes cluster", - "length": 255, - "name": "description", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "the ID of the service offering for the virtual machines in the cluster.", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" - }, + } + ] + }, + { + "description": "list Tungsten-Fabric network", + "isasync": false, + "name": "listTungstenFabricNetwork", + "params": [ { - "description": "password for the docker image private registry", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "dockerregistrypassword", + "name": "networkuuid", "required": false, "type": "string" }, { - "description": "Network in which Kubernetes cluster is to be launched", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", + "description": "List by keyword", "length": 255, - "name": "externalloadbalanceripaddress", + "name": "keyword", "required": false, "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "the ID of zone", "length": 255, - "name": "account", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "name of the ssh key pair used to login to the virtual machines", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false", "length": 255, - "name": "keypair", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "number of Kubernetes cluster worker nodes", + "description": "", "length": 255, - "name": "size", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" } ], - "related": "startKubernetesCluster", + "related": "", "response": [ { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "type": "string" - }, - { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "Tungsten-Fabric network uuid", + "name": "uuid", "type": "string" }, + {}, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "Tungsten-Fabric network name", + "name": "name", "type": "string" - }, + } + ] + }, + { + "description": "List traffic monitor Hosts.", + "isasync": false, + "name": "listTrafficMonitors", + "params": [ { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" + "description": "zone Id", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", - "type": "string" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "addTrafficMonitor", + "response": [ { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, {}, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" - }, - { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" - }, + "description": "the ID of the external firewall", + "name": "id", + "type": "string" + } + ] + }, + { + "description": "Releases an existing dedicated Bgp Peer.", + "isasync": true, + "name": "releaseBgpPeer", + "params": [ { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" - }, + "description": "Id of the Bgp Peer", + "length": 255, + "name": "id", + "related": "releaseBgpPeer", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the description of the Kubernetes cluster", - "name": "description", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { "description": "the UUID of the latest async job acting on this object", @@ -99471,13 +127779,13 @@ var preCache = `{ "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { @@ -99486,145 +127794,241 @@ var preCache = `{ "type": "integer" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", + "description": "the domain ID of the bgp peer", "name": "domainid", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", + "description": "id of the bgp peer", + "name": "id", + "type": "string" + }, + { + "description": "AS number of bgp peer", + "name": "asnumber", "type": "long" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, + {}, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" }, { - "description": "Public IP Address of the cluster", + "description": "IPv4 address of bgp peer", "name": "ipaddress", "type": "string" - }, - { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" } - ] + ], + "since": "4.20.0" }, { - "description": "List a storage network IP range.", - "isasync": false, - "name": "listStorageNetworkIpRange", + "description": "Updates a port forwarding rule. Only the private port and the virtual machine can be updated.", + "isasync": true, + "name": "updatePortForwardingRule", "params": [ { - "description": "", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "pagesize", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", + "description": "the private end port of the port forwarding rule", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "privateendport", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": " the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed.", "length": 255, - "name": "keyword", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { - "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", + "description": "the ID of the virtual machine for the port forwarding rule", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "virtualmachineid", + "related": "createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "required": false, "type": "uuid" }, { - "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "name": "customid", "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "length": 255, + "name": "id", + "related": "updatePortForwardingRule", + "required": true, + "since": "4.4", "type": "uuid" }, { - "description": "", + "description": "the private start port of the port forwarding rule", "length": 255, - "name": "page", + "name": "privateport", "required": false, "type": "integer" + }, + { + "description": "VM guest nic Secondary ip address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, + "since": "4.5", + "type": "string" } ], - "related": "createStorageNetworkIpRange", + "related": "", "response": [ { - "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": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "list" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, {}, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the uuid of storage network IP range.", + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "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 ID of the port forwarding rule", "name": "id", "type": "string" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" }, {}, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -99633,538 +128037,639 @@ var preCache = `{ "type": "string" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Enables HA for a host", - "isasync": true, - "name": "enableHAForHost", - "params": [ - { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "related": "configureHAForHost,disableHAForHost,listHostHAProviders", - "response": [ - { - "description": "the ID of the host", - "name": "hostid", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, + } + ] + }, + { + "description": "Acquires and associates a public IP to an account.", + "isasync": true, + "name": "associateIpAddress", + "params": [ { - "description": "if host HA is enabled for the host", - "name": "haenable", + "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", + "length": 255, + "name": "isportable", + "required": false, "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The network this IP address should be associated to.", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" }, - {}, - {} - ], - "since": "4.11" - }, - { - "description": "Deletes a specified domain", - "isasync": true, - "name": "deleteDomain", - "params": [ { - "description": "ID of domain to delete", + "description": "the VPC you want the IP address to be associated with", "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains", - "required": true, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, "type": "uuid" }, { - "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", + "description": "Deploy VM for the project", "length": 255, - "name": "cleanup", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" - } - ], - "response": [ + "type": "uuid" + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the availability zone you want to acquire an public IP address from", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account to associate with this IP address", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "IP Address to be associated", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "region ID from where portable IP is to be associated.", + "length": 255, + "name": "regionid", + "related": "", + "required": false, "type": "integer" }, - {} - ] - }, - { - "description": "Configures a virtual router element.", - "isasync": true, - "name": "configureVirtualRouterElement", - "params": [ { - "description": "Enabled/Disabled the service provider", + "description": "the ID of the domain to associate with this IP address", "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the ID of the virtual router provider", + "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, - "name": "id", - "related": "configureVirtualRouterElement,listVirtualRouterElements", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], - "related": "listVirtualRouterElements", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the account associated with the provider", - "name": "account", - "type": "string" + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "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 id of the router", - "name": "id", - "type": "string" + "description": "the list of resource tags associated with ip address", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "list" }, + {}, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", + "description": "is public IP portable across the zones", + "name": "isportable", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} - ] - }, - { - "description": "Migrate volume", - "isasync": true, - "name": "migrateVolume", - "params": [ - { - "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.", - "length": 255, - "name": "newdiskofferingid", - "related": "", - "required": false, - "type": "uuid" + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" }, { - "description": "the ID of the volume", - "length": 255, - "name": "volumeid", - "related": "createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "description": "the VLAN associated with the IP address", + "name": "vlanname", + "type": "string" }, { - "description": "if the volume should be live migrated when it is attached to a running vm", - "length": 255, - "name": "livemigrate", - "required": false, - "type": "boolean" + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "type": "string" }, { - "description": "destination storage pool ID to migrate the volume to", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": true, - "type": "uuid" - } - ], - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "public IP address id", + "name": "id", + "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "true if range is dedicated for external network providers", + "name": "forprovider", "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the name of the Network where ip belongs to", + "name": "networkname", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, + {}, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", "type": "boolean" - }, + } + ] + }, + { + "description": "Get the SF Volume Access Group IDs", + "isasync": false, + "name": "getSolidFireVolumeAccessGroupIds", + "params": [ { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "Cluster UUID", + "length": 255, + "name": "clusterid", + "required": true, "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "Storage Pool UUID", + "length": 255, + "name": "storageid", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "SolidFire Volume Access Group Ids", + "name": "solidFireVolumeAccessGroupIds", + "type": "long[]" }, + {} + ] + }, + { + "description": "Delete site to site vpn connection", + "isasync": true, + "name": "deleteVpnConnection", + "params": [ { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, + "description": "id of vpn connection", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ] + }, + { + "description": "Lists all alerts types", + "isasync": false, + "name": "listAlertTypes", + "params": [], + "related": "listAlerts", + "response": [ { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the name of the alert", + "name": "name", "type": "string" }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", + "name": "type", + "type": "short" }, + {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the date and time the alert was sent", + "name": "sent", + "type": "date" }, + {}, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "description of the alert", + "name": "description", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the id of the alert", + "name": "id", "type": "string" + } + ] + }, + { + "description": "Creates a ACL rule in the given network (the network has to belong to VPC)", + "isasync": true, + "name": "createNetworkACL", + "params": [ + { + "description": "the ending port of ACL", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "The network of the VM the ACL will be created for", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "The number of the ACL item, its ordering", + "length": 255, + "name": "number", + "required": false, "type": "integer" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "scl entry action, allow or deny", + "length": 255, + "name": "action", + "required": false, "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the starting port of ACL", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" }, { - "description": "the status of the volume", - "name": "status", + "description": "A description indicating why the ACL rule is required.", + "length": 255, + "name": "reason", + "required": false, "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "The network of the VM the ACL will be created for", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "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": "updateNetworkACLItem,moveNetworkAclItem", + "response": [ + {}, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the ID of the ACL Item", + "name": "id", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -100178,18 +128683,18 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -100198,8 +128703,13 @@ var preCache = `{ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -100208,495 +128718,369 @@ var preCache = `{ "type": "string" } ], - "type": "set" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "type": "list" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, - {}, { - "description": "shared or local storage", - "name": "storagetype", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, - {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "create Tungsten-Fabric application policy set", - "isasync": true, - "name": "createTungstenFabricApplicationPolicySet", - "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" }, + {}, { - "description": "Tungsten-Fabric application policy set name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - } - ], - "related": "", - "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": "Tungsten-Fabric policy name", - "name": "name", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", - "type": "list" - }, - {}, - { - "description": "Tungsten-Fabric application policy uuid", - "name": "uuid", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, - {}, - { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" - } - ] - }, - { - "description": "Lists HA providers", - "isasync": false, - "name": "listHostHAProviders", - "params": [ - { - "description": "Hypervisor type of the resource", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - } - ], - "related": "configureHAForHost,disableHAForHost", - "response": [ - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, { "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": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" - }, - {}, - { - "description": "the ID of the host", - "name": "hostid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" - }, - { - "description": "operation status", - "name": "status", - "type": "boolean" } - ], - "since": "4.11" + ] }, { - "description": "A command to list events.", - "isasync": false, - "name": "listEvents", + "description": "Resets the SSH Key for virtual machine. The virtual machine must be in a \"Stopped\" state. [async]", + "isasync": true, + "name": "resetSSHKeyForVirtualMachine", "params": [ { - "description": "the ID of the event", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "id", - "related": "listEvents", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "the event type (see event types)", + "description": "an optional project for the ssh key", "length": 255, - "name": "type", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "The ID of the virtual machine", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, + "name": "id", + "related": "createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "keypair", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "names of the ssh key pairs to be used to login to the virtual machine", "length": 255, - "name": "keyword", + "name": "keypairs", "required": false, + "since": "4.17", + "type": "list" + } + ], + "related": "createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ + { + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "true to list archived events otherwise false", - "length": 255, - "name": "archived", - "required": false, - "since": "4.19.0", - "type": "boolean" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the time the event was entered", - "length": 255, - "name": "entrytime", - "required": false, - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the duration of the event", - "length": 255, - "name": "duration", - "required": false, - "type": "integer" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "the event level (INFO, WARN, ERROR)", - "length": 255, - "name": "level", - "required": false, + "description": "the name of the virtual machine", + "name": "name", "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, + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the resource associated with the event", - "length": 255, - "name": "resourceid", - "required": false, - "since": "4.17.0", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, + {}, + {}, { - "description": "the end date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the type of the resource associated with the event", - "length": 255, - "name": "resourcetype", - "required": false, - "since": "4.17.0", + "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 start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event", - "length": 255, - "name": "startid", - "related": "listEvents", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the type of the event (see event types)", - "name": "type", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, - {}, { - "description": "the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)", - "name": "account", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "a brief description of the event", - "name": "description", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the event level (INFO, WARN, ERROR)", - "name": "level", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "whether the event is parented", - "name": "parentid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "the project name of the address", - "name": "project", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the id of the account's domain", - "name": "domainid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the account's domain", - "name": "domain", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the date the event was created", - "name": "created", - "type": "date" + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" }, { - "description": "the ID of the event", - "name": "id", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the id of the resource", - "name": "resourceid", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "whether the event has been archived or not", - "name": "archived", - "type": "boolean" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the state of the event", - "name": "state", - "type": "state" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the name of the resource", - "name": "resourcename", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the type of the resource", - "name": "resourcetype", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, - {} - ] - }, - { - "description": "Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect.", - "isasync": true, - "name": "updateVMAffinityGroup", - "params": [ { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", - "length": 255, - "name": "affinitygroupnames", - "related": "", - "required": false, - "type": "list" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", - "length": 255, - "name": "affinitygroupids", - "related": "", - "required": false, - "type": "list" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, { "description": "the hypervisor on which the template runs", "name": "hypervisor", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ - { - "description": "the name of the security group", - "name": "name", - "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", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "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": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -100704,95 +129088,90 @@ var preCache = `{ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { "description": "tag value", "name": "value", "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "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", + "description": "security group name", + "name": "securitygroupname", "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" } ], "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", + "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the list of virtualmachine ids associated with this securitygroup", @@ -100800,33 +129179,48 @@ var preCache = `{ "type": "set" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the account owning the security group", + "name": "account", + "type": "string" }, { "description": "the description of the security group", "name": "description", "type": "string" }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "the ending IP of the security group rule ", @@ -100834,57 +129228,57 @@ var preCache = `{ "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -100893,22 +129287,32 @@ var preCache = `{ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { "description": "the code for the ICMP message response", @@ -100919,88 +129323,445 @@ var preCache = `{ "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ID of the security group", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ], "type": "set" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "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 ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { @@ -101009,43 +129770,68 @@ var preCache = `{ "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { @@ -101053,23 +129839,28 @@ var preCache = `{ "name": "affinitygroup", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { @@ -101078,145 +129869,177 @@ var preCache = `{ "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" } ], "type": "set" }, - {}, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "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 ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" - }, + } + ] + }, + { + "description": "Deletes a management network IP range. This action is only allowed when no IPs in this range are allocated.", + "isasync": true, + "name": "deleteManagementNetworkIpRange", + "params": [ { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "The ending IP address.", + "length": 255, + "name": "endip", + "required": true, "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "UUID of POD, where the IP range belongs to.", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" + }, + { + "description": "The starting IP address.", + "length": 255, + "name": "startip", + "required": true, "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "The vlan id the ip range sits on", + "length": 255, + "name": "vlan", + "required": true, + "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", @@ -101224,110 +130047,327 @@ var preCache = `{ "type": "integer" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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.11.0.0" + }, + { + "description": "Add a supported Kubernetes version", + "isasync": false, + "name": "addKubernetesSupportedVersion", + "params": [ { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the minimum number of CPUs to be set with the Kubernetes version", + "length": 255, + "name": "mincpunumber", + "required": true, "type": "integer" }, - {}, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the minimum RAM size in MB to be set with the Kubernetes version", + "length": 255, + "name": "minmemory", + "required": true, + "type": "integer" + }, + { + "description": "the CPU arch of the Kubernetes ISO. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", + "length": 255, + "name": "semanticversion", + "required": true, + "type": "string" + }, + { + "description": "If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false", + "length": 255, + "name": "directdownload", + "required": false, + "since": "4.18.2", + "type": "boolean" + }, + { + "description": "the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", + "required": false, + "type": "string" + }, + { + "description": "the name of the Kubernetes supported version", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the ID of the zone in which Kubernetes supported version will be available", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the URL of the binaries ISO for Kubernetes supported version", + "length": 255, + "name": "url", + "required": false, + "type": "string" + } + ], + "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "response": [ + { + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", + "type": "string" + }, + { + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", + "type": "string" + }, + { + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", "type": "integer" }, { - "description": "the date when this virtual machine was created", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" + }, + { + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the date when this Kubernetes supported version was created", "name": "created", "type": "date" }, + {}, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, + {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "Kubernetes semantic version", + "name": "semanticversion", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", + "type": "string" + } + ] + }, + { + "description": "Register a CNI Configuration to be used with CKS cluster", + "isasync": false, + "name": "registerCniConfiguration", + "params": [ + { + "description": "CNI Configuration content to be registered as User data", + "length": 1048576, + "name": "cniconfig", + "required": false, + "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "an optional account for the user data. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "an optional domainId for the user data. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "an optional project for the user data", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "comma separated list of variables declared in user data content", + "length": 255, + "name": "params", + "required": false, "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "Name of the user data", + "length": 255, + "name": "name", + "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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ], + "since": "4.21.0" + }, + { + "description": "Link or unlink a userdata to a template.", + "isasync": false, + "name": "linkUserDataToTemplate", + "params": [ + { + "description": "the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", + "length": 255, + "name": "userdatapolicy", + "required": false, + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the ISO for the virtual machine", + "length": 255, + "name": "isoid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" + } + ], + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { "description": "Base64 string representation of the resource icon", @@ -101335,762 +130375,837 @@ var preCache = `{ "type": "resourceiconresponse" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, + {}, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + {}, { - "description": "the ID of the availability zone for the virtual machine", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the zone for this template", "name": "zoneid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "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": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" } - ] + ], + "since": "4.18.0" }, { - "description": "Registers NCC Service Package", + "description": "Lists the custom actions", "isasync": false, - "name": "registerNetscalerServicePackage", + "name": "listCustomActions", "params": [ { - "description": "Description of Service Package", + "description": "Type of the resource for actions", "length": 255, - "name": "description", - "required": true, + "name": "resourcetype", + "required": false, "type": "string" }, { - "description": "Name of the service Package.", + "description": "uuid of the custom action", "length": 255, - "name": "name", - "required": true, - "type": "string" - } - ], - "related": "listRegisteredServicePackages", - "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" + "name": "id", + "related": "listCustomActions", + "required": false, + "type": "uuid" }, { - "description": "Service Package Name", + "description": "Name of the custom action", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "Description of Service Package", - "name": "description", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, - {}, - {}, - { - "description": "Service Package UUID", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Creates resource tag(s)", - "isasync": true, - "name": "createTags", - "params": [ { - "description": "list of resources to create the tags for", + "description": "", "length": 255, - "name": "resourceids", - "required": true, - "type": "list" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "type of the resource", + "description": "", "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Map of tags (key/value pairs)", + "description": "uuid of the extension", "length": 255, - "name": "tags", - "required": true, - "type": "map" + "name": "extensionid", + "related": "listExtensions,updateExtension", + "required": false, + "type": "uuid" }, { - "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", + "description": "ID of a resource for actions", "length": 255, - "name": "customer", + "name": "resourceid", "required": false, "type": "string" + }, + { + "description": "List actions whether they are enabled or not", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" } ], + "related": "", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "Specifies the timeout in seconds to wait for the action to complete before failing", + "name": "timeout", + "type": "integer" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "List of the parameters for the action", + "name": "parameters", + "response": [ + { + "description": "Comma-separated list of options for value of the parameter", + "name": "valueoptions", + "type": "list" + }, + { + "description": "Type of the parameter", + "name": "type", + "type": "string" + }, + { + "description": "Validation format for value of the parameter. Available for specific types", + "name": "validationformat", + "type": "string" + }, + { + "description": "Whether the parameter is required or not", + "name": "required", + "type": "boolean" + }, + { + "description": "Name of the parameter", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Resource type for which the action is available", + "name": "resourcetype", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.0.0" - }, - { - "description": "Create an Internal Load Balancer element.", - "isasync": true, - "name": "createInternalLoadBalancerElement", - "params": [ - { - "description": "the network service provider ID of the internal load balancer element", - "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders", - "required": true, - "type": "uuid" - } - ], - "related": "configureInternalLoadBalancerElement", - "response": [ + "description": "Details of the custom action", + "name": "details", + "type": "map" + }, { - "description": "Enabled/Disabled the element", + "description": "Whether the custom action is enabled or not", "name": "enabled", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the extension that this custom action belongs to", + "name": "extensionname", "type": "string" }, - {}, { - "description": "the physical network service provider id of the element", - "name": "nspid", - "type": "string" + "description": "Creation timestamp of the custom action", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "List of role types allowed for the custom action", + "name": "allowedroletypes", + "type": "list" }, - {}, { - "description": "the id of the internal load balancer element", - "name": "id", + "description": "Description of the custom action", + "name": "description", "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Lists the CA public certificate(s) as support by the configured/provided CA plugin", - "isasync": false, - "name": "listCaCertificate", - "params": [ + }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", - "length": 255, - "name": "provider", - "required": false, + "description": "Message that will be used on successful execution of the action", + "name": "successmessage", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "Private key for the certificate", - "name": "privatekey", + "description": "Name of the custom action", + "name": "name", "type": "string" }, { - "description": "The CA certificate(s)", - "name": "cacertificates", + "description": "ID of the custom action", + "name": "id", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Message that will be used on failure during execution of the action", + "name": "errormessage", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "The client certificate", - "name": "certificate", + "description": "ID of the extension that this custom action belongs to", + "name": "extensionid", "type": "string" } ], - "since": "4.11.0" + "since": "4.21.0" }, { - "description": "Reset api count", + "description": "Lists load balancer rules.", "isasync": false, - "name": "resetApiLimit", + "name": "listGlobalLoadBalancerRules", "params": [ { - "description": "the ID of the account whose limit to be reset", + "description": "region ID", "length": 255, - "name": "account", - "related": "enableAccount,listAccounts,listAccounts", + "name": "regionid", + "related": "", "required": false, - "type": "uuid" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "type": "integer" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "Creates a VLAN IP range.", - "isasync": false, - "name": "deleteVlanIpRange", - "params": [ - { - "description": "the id of the VLAN IP range", + "description": "the ID of the global load balancer rule", "length": 255, "name": "id", - "related": "dedicatePublicIpRange", - "required": true, + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "required": false, "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", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Provisions a host with a direct download certificate", - "isasync": false, - "name": "provisionTemplateDirectDownloadCertificate", - "params": [ + "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": "the id of the direct download certificate to provision", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate", - "required": true, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "the host to provision the certificate", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "required": true, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, "type": "uuid" } ], - "related": "", + "related": "updateGlobalLoadBalancerRule", "response": [ { - "description": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the host", - "name": "hostname", + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, - {} - ], - "since": "4.17.0" - }, - { - "description": "Creates a Project role", - "isasync": false, - "name": "updateProjectRole", - "params": [ { - "description": "The description of the Project role", - "length": 255, - "name": "description", - "required": false, + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, + {}, { - "description": "ID of the Project role", - "length": 255, - "name": "id", - "related": "updateProjectRole", - "required": true, - "type": "uuid" - }, - { - "description": "ID of project where role is being created", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" + "description": "the project name of the load balancer", + "name": "project", + "type": "string" }, { - "description": "creates a project role with this unique name", - "length": 255, - "name": "name", - "required": false, + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the description of the role", - "name": "description", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, {}, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the id of the project", - "name": "projectid", - "type": "string" + "description": "List of load balancer rules that are part of GSLB rule", + "name": "loadbalancerrule", + "response": [ + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the list of resource tags associated with load balancer", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + } + ], + "type": "list" }, { "description": "the current status of the latest async job acting on this object", @@ -102098,245 +131213,169 @@ var preCache = `{ "type": "integer" }, { - "description": "the name of the role", - "name": "name", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, - {} - ], - "since": "4.15.0" - }, - { - "description": "Generates an alert", - "isasync": true, - "name": "generateAlert", - "params": [ - { - "description": "Type of the alert", - "length": 255, - "name": "type", - "required": true, - "type": "short" - }, { - "description": "Name of the alert", - "length": 255, - "name": "name", - "required": true, + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, { - "description": "Zone id for which alert is generated", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Alert description", - "length": 999, - "name": "description", - "required": true, + "description": "global load balancer rule ID", + "name": "id", "type": "string" - }, + } + ] + }, + { + "description": "Release the dedication for cluster", + "isasync": true, + "name": "releaseDedicatedCluster", + "params": [ { - "description": "Pod id for which alert is generated", + "description": "the ID of the Cluster", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, "type": "uuid" } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "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" - } - ], - "since": "4.3" + }, + {} + ] }, { - "description": "Add a new Ldap Configuration", + "description": "Updates a disk offering.", "isasync": false, - "name": "addLdapConfiguration", + "name": "deleteDiskOffering", "params": [ { - "description": "Hostname", + "description": "ID of the disk offering", "length": 255, - "name": "hostname", + "name": "id", + "related": "", "required": true, - "type": "string" - }, - { - "description": "linked domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, "type": "uuid" - }, - { - "description": "Port", - "length": 255, - "name": "port", - "required": true, - "type": "integer" } ], - "related": "", "response": [ { - "description": "name of the host running the ldap server", - "name": "hostname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" + "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": "linked domain", - "name": "domainid", - "type": "string" - }, {} - ], - "since": "4.2.0" + ] }, { - "description": "(Deprecated, use addLdapConfiguration) Configure the LDAP context for this site.", + "description": "Get Kubernetes cluster config", "isasync": false, - "name": "ldapConfig", + "name": "getKubernetesClusterConfig", "params": [ { - "description": "Enter the password.", - "length": 255, - "name": "bindpass", - "required": false, - "type": "string" - }, - { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", - "length": 255, - "name": "searchbase", - "required": false, - "type": "string" - }, - { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", - "length": 255, - "name": "queryfilter", - "required": false, - "type": "string" - }, - { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "ssl", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster", "required": false, - "type": "boolean" - }, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "Specify the distinguished name of a user with the search permission on the directory.", - "length": 255, - "name": "binddn", - "required": false, + "description": "Name of the container cluster", + "name": "name", "type": "string" }, + {}, + {}, { - "description": "Enter the password for trust store.", - "length": 255, - "name": "truststorepass", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "If true return current LDAP configuration", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Enter the path to trust certificates store.", - "length": 255, - "name": "truststore", - "required": false, + "description": "the id of the container cluster", + "name": "id", "type": "string" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "length": 255, - "name": "hostname", - "required": false, + "description": "the config data of the cluster", + "name": "configdata", "type": "string" - }, + } + ] + }, + { + "description": "Deletes a autoscale policy.", + "isasync": true, + "name": "deleteAutoScalePolicy", + "params": [ { - "description": "Specify the LDAP port if required, default is 389.", + "description": "the ID of the autoscale policy", "length": 255, - "name": "port", - "required": false, - "type": "integer" + "name": "id", + "related": "listAutoScalePolicies", + "required": true, + "type": "uuid" } ], - "related": "ldapRemove", "response": [ { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", - "type": "string" - }, - { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", - "name": "searchbase", - "type": "string" - }, - { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { @@ -102345,94 +131384,78 @@ var preCache = `{ "type": "integer" }, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", - "type": "string" - }, - { - "description": "DN password", - "name": "bindpass", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {} - ], - "since": "3.0.0" + ] }, { - "description": "List vSphere storage policies", + "description": "Deletes a role", "isasync": false, - "name": "listVsphereStoragePolicies", + "name": "deleteRole", "params": [ { - "description": "ID of the zone", + "description": "ID of the role", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, + "name": "id", + "related": "createRole,listRoles,updateRole", + "required": true, "type": "uuid" } ], - "related": "", "response": [ { - "description": "the ID of the Zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", - "type": "string" - }, - { - "description": "the description of the Storage Policy", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the Storage Policy", - "name": "id", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "the name of the Storage Policy", - "name": "name", - "type": "string" - }, - {} - ] + } + ], + "since": "4.9.0" }, { - "description": "Deletes a port forwarding rule", + "description": " delete a Cisco Nexus VSM device", "isasync": true, - "name": "deletePortForwardingRule", + "name": "deleteCiscoNexusVSM", "params": [ { - "description": "the ID of the port forwarding rule", + "description": "Id of the Cisco Nexus 1000v VSM device to be deleted", "length": 255, "name": "id", - "related": "updateIpv6FirewallRule", + "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "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", @@ -102443,426 +131466,894 @@ var preCache = `{ "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": "moves a vpc to another physical network", - "isasync": true, - "name": "migrateVPC", + "description": "List internal LB VMs.", + "isasync": false, + "name": "listInternalLoadBalancerVMs", "params": [ { - "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", + "description": "the state of the Internal LB VM", "length": 255, - "name": "tiernetworkofferings", + "name": "state", "required": false, - "type": "map" + "type": "string" }, { - "description": "true if previous network migration cmd failed", + "description": "if true is passed for this parameter, list only VPC Internal LB VMs", "length": 255, - "name": "resume", + "name": "forvpc", "required": false, "type": "boolean" }, { - "description": "vpc offering ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", - "required": true, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "the ID of the vpc", + "description": "the Zone ID of the Internal LB VM", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the host ID of the Internal LB VM", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Internal LB VM", + "length": 255, + "name": "id", + "related": "createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "the Pod ID of the Internal LB VM", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "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 Internal LB VMs by VPC", "length": 255, "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, "type": "uuid" - } - ], - "related": "createVPC,listVPCs,updateVPC", - "response": [ + }, { - "description": "the project name of the VPC", - "name": "project", - "type": "string" + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", + "length": 255, + "name": "fetchhealthcheckresults", + "required": false, + "since": "4.14", "type": "boolean" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the name of the VPC", + "description": "the name of the Internal LB VM", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "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 name of the zone the VPC belongs to", - "name": "zonename", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "listRouters", + "response": [ + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account associated with the router", + "name": "account", + "type": "string" }, { - "description": "the id of the VPC", - "name": "id", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "the list of supported services", - "name": "service", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - } - ], + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "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": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the service name", - "name": "name", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" - } - ], - "type": "list" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" - }, - {}, - {}, - { - "description": "the list of resource tags associated with the project", - "name": "tags", - "response": [ + }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 account associated with the tag", - "name": "account", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + {}, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the domain id of the VPC owner", + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the domain ID associated with the router", "name": "domainid", "type": "string" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + } + ] + }, + { + "description": "Lists Cisco VNMC controllers", + "isasync": false, + "name": "listCiscoVnmcResources", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "Cisco VNMC resource ID", + "length": 255, + "name": "resourceid", + "related": "listCiscoVnmcResources", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" } ], - "since": "4.11.0" + "related": "", + "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": "Deletes a global load balancer rule.", + "description": "Execute DRS for a cluster. If there is another plan in progress for the same cluster, this command will fail.", "isasync": true, - "name": "deleteGlobalLoadBalancerRule", + "name": "executeClusterDrsPlan", "params": [ { - "description": "the ID of the global load balancer rule", + "description": "ID of cluster", "length": 255, "name": "id", - "related": "", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" + }, + { + "description": "Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=&migrateto[vm-index].host= Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm= indicates the UUID of the vm that you want to migrate, and host= indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", + "length": 255, + "name": "migrateto", + "required": false, + "type": "map" } ], + "related": "", "response": [ + { + "description": "Status of DRS Plan", + "name": "status", + "type": "status" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "Id of the cluster", + "name": "clusterid", + "type": "string" + }, + { + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" + }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "List of migrations", + "name": "migrations", + "type": "list" + }, + { + "description": "unique ID of the drs plan for cluster", + "name": "id", + "type": "string" + }, + { + "description": "Start event Id of the DRS Plan", + "name": "eventid", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Deletes a particular egress rule from this security group", + "isasync": true, + "name": "revokeSecurityGroupEgress", + "params": [ + { + "description": "The ID of the egress rule", + "length": 255, + "name": "id", + "related": "authorizeSecurityGroupIngress", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Uploads an icon for the specified resource(s)", + "isasync": false, + "name": "uploadResourceIcon", + "params": [ + { + "description": "list of resources to upload the icon/image for", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" + }, + { + "description": "type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon/image", + "length": 2097152, + "name": "base64image", + "required": true, + "type": "string" + } + ], + "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.16.0.0" }, { - "description": "update an annotation visibility.", + "description": "Update a supported Kubernetes version", "isasync": false, - "name": "updateAnnotationVisibility", + "name": "updateKubernetesSupportedVersion", "params": [ { - "description": "the id of the annotation", + "description": "the ID of the Kubernetes supported version", "length": 255, "name": "id", + "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the annotation is visible for admins only", + "description": "the enabled or disabled state of the Kubernetes supported version", "length": 255, - "name": "adminsonly", + "name": "state", "required": true, - "type": "boolean" + "type": "string" } ], - "related": "removeAnnotation", + "related": "listKubernetesSupportedVersions", "response": [ { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" + }, + { + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -102870,281 +132361,388 @@ var preCache = `{ "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, - {}, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" + }, + { + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", "type": "boolean" }, + { + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" + }, + { + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", + "type": "string" + }, {}, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", + "type": "string" + }, + { + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", + "type": "string" + }, + { + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, + { + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" + }, + {}, + { + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Deletes an existing IPv4 subnet for a zone.", + "isasync": true, + "name": "deleteIpv4SubnetForZone", + "params": [ + { + "description": "Id of the guest network IPv4 subnet", + "length": 255, + "name": "id", + "related": "dedicateIpv4SubnetForZone", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", - "type": "string" - } + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {} ], - "since": "4.16" + "since": "4.20.0" }, { - "description": "create Tungsten-Fabric address group", + "description": "Creates a guest network IPv6 prefix.", "isasync": true, - "name": "createTungstenFabricAddressGroup", + "name": "createGuestNetworkIpv6Prefix", "params": [ { - "description": "Tungsten-Fabric address group name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the ID of zone", + "description": "UUID of zone to which the IPv6 prefix belongs to.", "length": 255, "name": "zoneid", - "related": "createZone,listZones", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "Tungsten-Fabric ip prefix length", - "length": 255, - "name": "ipprefixlen", - "required": true, - "type": "integer" - }, - { - "description": "Tungsten-Fabric ip prefix", + "description": "The /56 or higher IPv6 CIDR for network prefix.", "length": 255, - "name": "ipprefix", + "name": "prefix", "required": true, "type": "string" } ], - "related": "", + "related": "listGuestNetworkIpv6Prefixes", "response": [ + {}, { - "description": "Tungsten-Fabric address group ip prefix", - "name": "ipprefix", + "description": "guest IPv6 prefix", + "name": "prefix", "type": "string" }, { - "description": "Tungsten-Fabric address group ip prefix length", - "name": "ipprefixlen", - "type": "int" + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id of the guest IPv6 prefix", + "name": "id", + "type": "string" }, { - "description": "Tungsten-Fabric address group uuid", - "name": "uuid", + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" }, { - "description": "Tungsten-Fabric address group name", - "name": "name", - "type": "string" + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.17.0.0" }, { - "description": "Lists BigSwitch BCF Controller devices", + "description": "Creates a role", "isasync": false, - "name": "listBigSwitchBcfDevices", + "name": "createRole", "params": [ { - "description": "", + "description": "ID of the role to be cloned from. Either roleid or type must be passed in", "length": 255, - "name": "pagesize", + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "Creates a role with this unique name", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", "length": 255, - "name": "page", + "name": "ispublic", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "bigswitch BCF controller device ID", + "description": "The description of the role", "length": 255, - "name": "bcfdeviceid", - "related": "listBigSwitchBcfDevices", + "name": "description", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "", + "related": "listRoles,updateRole", "response": [ { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "the name of the role", + "name": "name", "type": "string" }, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "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": "device name", - "name": "bigswitchdevicename", + "description": "the description of the role", + "name": "description", "type": "string" }, + {}, { - "description": "the controller username", - "name": "username", + "description": "the state of the role", + "name": "state", "type": "string" }, - {}, { - "description": "the controller password", - "name": "password", - "type": "string" + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "the ID of the role", + "name": "id", "type": "string" }, - { - "description": "NAT support", - "name": "nat", - "type": "boolean" - } + {} ], - "since": "4.6.0" + "since": "4.9.0" }, { - "description": "Configures HA for a host", - "isasync": true, - "name": "configureHAForHost", + "description": "Upload a data disk to the cloudstack cloud.", + "isasync": false, + "name": "getUploadParamsForVolume", "params": [ { - "description": "ID of the host", + "description": "Image store uuid", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "required": true, + "name": "imagestoreuuid", + "required": false, + "type": "string" + }, + { + "description": "Upload volume/template/iso for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "HA provider", + "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", "length": 255, - "name": "provider", + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "name": "format", + "required": true, + "type": "string" + }, + { + "description": "the name of the volume/template/iso", + "length": 255, + "name": "name", "required": true, "type": "string" + }, + { + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", + "required": false, + "type": "string" + }, + { + "description": "the ID of the zone the volume/template/iso is to be hosted on", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], - "related": "disableHAForHost", + "related": "getUploadParamsForTemplate,getUploadParamsForIso", "response": [ { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "signature to be sent in the POST request.", + "name": "signature", + "type": "string" }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "the template/volume ID", + "name": "id", + "type": "uuid" }, + {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "the timestamp after which the signature expires", + "name": "expires", "type": "string" }, - {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", + "type": "string" }, {}, + { + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -103154,303 +132752,235 @@ var preCache = `{ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" } ], - "since": "4.11" + "since": "4.6.0" }, { - "description": "Updates a configuration.", - "isasync": false, - "name": "updateConfiguration", + "description": "Updates an existing autoscale vm profile.", + "isasync": true, + "name": "updateAutoScaleVmProfile", "params": [ { - "description": "the ID of the Domain to update the parameter value for corresponding domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "the name of the configuration", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "name", - "required": true, + "name": "customid", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", + "description": "the template of the auto deployed virtual machine", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "uuid" }, { - "description": "the value of the configuration", - "length": 4096, - "name": "value", + "description": "the ID of the userdata", + "length": 255, + "name": "userdataid", + "related": "", "required": false, - "type": "string" + "since": "4.18.1", + "type": "uuid" }, { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", "length": 255, - "name": "imagestoreuuid", - "related": "listSwifts,addImageStoreS3,listImageStores", + "name": "counterparam", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "otherdeployparams", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "map" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", + "name": "expungevmgraceperiod", "required": false, + "type": "integer" + }, + { + "description": "the ID of the autoscale vm profile", + "length": 255, + "name": "id", + "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, "type": "uuid" }, { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", + "description": "the ID of the user used to launch and destroy the VMs", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "autoscaleuserid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the name of the configuration", - "name": "name", - "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "an optional field, whether to the display the profile to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", - "type": "string" + "description": "the service offering of the auto deployed virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.18.0", + "type": "uuid" }, { - "description": "the value of the configuration", - "name": "value", + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18.1", + "type": "map" + } + ], + "related": "listAutoScaleVmProfiles", + "response": [ + { + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", + "description": "is profile for display to the regular user", + "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, + {}, { - "description": "the group of the configuration", - "name": "group", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { - "description": "the category of the configuration", - "name": "category", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the description of the configuration", - "name": "description", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, + {}, { - "description": "the type of the configuration value", - "name": "type", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, { - "description": "the value of the configuration", - "name": "id", - "type": "long" + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", + "type": "string" }, { - "description": "the component of the configuration", - "name": "component", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" - } - ] - }, - { - "description": "Lists volume stats", - "isasync": false, - "name": "listVolumesUsageHistory", - "params": [ - { - "description": "the IDs of the volumes, mutually exclusive with id.", - "length": 255, - "name": "ids", - "related": "migrateSystemVm", - "required": false, - "type": "list" - }, - { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the ID of the volume.", - "length": 255, - "name": "id", - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", + "type": "string" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", - "length": 255, - "name": "name", - "required": false, + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" - } - ], - "related": "", - "response": [ + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the volume", - "name": "id", - "type": "string" - }, - { - "description": "the name of the volume", - "name": "name", - "type": "string" - }, - { - "description": "the list of VM stats", - "name": "stats", - "type": "list" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" - }, - {}, - {} - ], - "since": "4.18.0" + } + ] }, { - "description": "Dedicates a Public IP range to an account", - "isasync": false, - "name": "dedicatePublicIpRange", + "description": "Enables an AutoScale Vm Group", + "isasync": true, + "name": "enableAutoScaleVmGroup", "params": [ { - "description": "the id of the VLAN IP range", + "description": "the ID of the autoscale group", "length": 255, "name": "id", - "related": "dedicatePublicIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "project who will own the VLAN", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, - { - "description": "account who will own the VLAN", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "domain ID of the account owning a VLAN", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "related": "enableAutoScaleVmGroup", "required": true, "type": "uuid" } @@ -103458,443 +132988,647 @@ var preCache = `{ "related": "", "response": [ { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", - "type": "string" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" + }, + { + "description": "is group for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the project name of the vlan range", + "description": "the project name of the vm group", "name": "project", "type": "string" }, - {}, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, - {}, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" + }, + { + "description": "the date when this vm group was created", + "name": "created", + "type": "date" + }, + { + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", - "type": "string" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" - } + "description": "the load balancer rule ID", + "name": "lbruleid", + "type": "string" + }, + {} ] }, { - "description": "Adds API permissions to a project role", + "description": "Lists guest network IPv6 prefixes", "isasync": false, - "name": "createProjectRolePermission", + "name": "listGuestNetworkIpv6Prefixes", "params": [ { - "description": "The API name or wildcard rule such as list*", + "description": "List by keyword", "length": 255, - "name": "rule", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "ID of the project role", + "description": "UUID of zone to which the IPv6 prefix belongs to.", "length": 255, - "name": "projectroleid", - "related": "", - "required": true, + "name": "zoneid", + "related": "listZones", + "required": false, "type": "uuid" }, { - "description": "The rule permission, allow or deny. Default: deny.", + "description": "", "length": 255, - "name": "permission", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "ID of project where project role permission is to be created", + "description": "UUID of the IPv6 prefix.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, + "name": "id", + "related": "listGuestNetworkIpv6Prefixes", + "required": false, "type": "uuid" }, { - "description": "The description of the role permission", + "description": "", "length": 255, - "name": "description", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "the description of the role permission", - "name": "description", + "description": "guest IPv6 prefix", + "name": "prefix", "type": "string" }, {}, { - "description": "the ID of the project role permission", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the project", - "name": "projectid", - "type": "string" + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", + "type": "integer" }, + {}, { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", - "type": "string" + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "id of the guest IPv6 prefix", + "name": "id", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" } ], - "since": "4.15.0" + "since": "4.17.0" }, { - "description": "Deletes an empty Bucket.", - "isasync": false, - "name": "deleteBucket", + "description": "Updates the information about Guest OS to Hypervisor specific name mapping", + "isasync": true, + "name": "updateGuestOsMapping", "params": [ { - "description": "The ID of the Bucket", + "description": "UUID of the Guest OS to hypervisor name Mapping", "length": 255, "name": "id", - "related": "", + "related": "updateGuestOsMapping", "required": true, "type": "uuid" + }, + { + "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", + "length": 255, + "name": "osmappingcheckenabled", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "Hypervisor specific name for this Guest OS", + "length": 255, + "name": "osnameforhypervisor", + "required": true, + "type": "string" } ], + "related": "", "response": [ + { + "description": "the ID of the Guest OS type", + "name": "ostypeid", + "type": "string" + }, + { + "description": "standard display name for the Guest OS", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", + "type": "string" + }, + {}, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the Guest OS mapping", + "name": "id", + "type": "string" + }, + { + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "is the mapping user defined", + "name": "isuserdefined", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the hypervisor", + "name": "hypervisor", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + } + ], + "since": "4.4.0" + }, + { + "description": "delete Tungsten-Fabric tag", + "isasync": true, + "name": "deleteTungstenFabricTag", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, + { + "description": "the uuid of Tungsten-Fabric tag", + "length": 255, + "name": "taguuid", + "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 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.19.0" + ] }, { - "description": "lists registered service packages", + "description": "Update password of a host/pool on management server.", "isasync": false, - "name": "listRegisteredServicePackages", + "name": "updateHostPassword", "params": [ { - "description": "List by keyword", + "description": "if the password should also be updated on the hosts", "length": 255, - "name": "keyword", + "name": "update_passwd_on_host", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "the host ID", "length": 255, - "name": "page", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "the new password for the host/cluster", "length": 255, - "name": "pagesize", + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "the username for the host/cluster", + "length": 255, + "name": "username", + "required": true, + "type": "string" } ], - "related": "", "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": "Service Package UUID", - "name": "id", - "type": "string" - }, - { - "description": "Service Package Name", - "name": "name", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "Description of Service Package", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Create a console endpoint to connect to a VM console", - "isasync": false, - "name": "createConsoleEndpoint", + "description": "adds a range of portable public IP's to a region", + "isasync": true, + "name": "createPortableIpRange", "params": [ { - "description": "ID of the VM", + "description": "the gateway for the portable IP range", "length": 255, - "name": "virtualmachineid", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "gateway", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "(optional) extra security token, valid when the extra validation is enabled", + "description": "the beginning IP address in the portable IP range", "length": 255, - "name": "token", + "name": "startip", + "required": true, + "type": "string" + }, + { + "description": "VLAN id, if not specified defaulted to untagged", + "length": 255, + "name": "vlan", "required": false, "type": "string" + }, + { + "description": "the netmask of the portable IP range", + "length": 255, + "name": "netmask", + "required": true, + "type": "string" + }, + { + "description": "the ending IP address in the portable IP range", + "length": 255, + "name": "endip", + "required": true, + "type": "string" + }, + { + "description": "Id of the Region", + "length": 255, + "name": "regionid", + "related": "", + "required": true, + "type": "integer" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the console url", - "name": "url", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", "type": "integer" }, + {}, { - "description": "the console websocket options", - "name": "websocket", - "type": "consoleendpointwebsocketresponse" + "description": "the start ip of the portable IP range", + "name": "startip", + "type": "string" }, { - "description": "true if the console endpoint is generated properly", - "name": "success", - "type": "boolean" + "description": "the end ip of the portable IP range", + "name": "endip", + "type": "string" }, - {}, { - "description": "details in case of an error", - "name": "details", + "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", + "name": "portableipaddress", + "response": [ + { + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the account ID the portable IP address is associated with", + "name": "accountid", + "type": "string" + }, + { + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", + "type": "string" + }, + { + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "VPC the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "portable IP range ID", + "name": "id", "type": "string" } ], - "since": "4.18.0" + "since": "4.2.0" }, { - "description": "Updates a project role permission and/or order", + "description": "Deletes Webhook delivery", "isasync": false, - "name": "updateProjectRolePermission", + "name": "deleteWebhookDelivery", "params": [ { - "description": "ID of the project role", + "description": "The ID of the Webhook delivery", "length": 255, - "name": "projectroleid", + "name": "id", "related": "", - "required": true, + "required": false, "type": "uuid" }, { - "description": "ID of project where project role permission is to be updated", + "description": "The ID of the Webhook", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, + "name": "webhookid", + "related": "createWebhook", + "required": false, "type": "uuid" }, { - "description": "Project Role permission rule id", + "description": "The start date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having start date equal to or after the specified date will be considered.", "length": 255, - "name": "projectrolepermissionid", - "related": "", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "The ID of the management server", "length": 255, - "name": "ruleorder", + "name": "managementserverid", "related": "", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "Rule permission, can be: allow or deny", + "description": "The end date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having end date equal to or before the specified date will be considered.", "length": 255, - "name": "permission", + "name": "enddate", "required": false, - "type": "string" + "type": "date" } ], "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", @@ -103905,1499 +133639,1878 @@ var preCache = `{ "name": "displaytext", "type": "string" }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } ], - "since": "4.15.0" + "since": "4.20.0" }, { - "description": "Enables static NAT for given IP address", + "description": "Update the extension", "isasync": false, - "name": "enableStaticNat", + "name": "updateExtension", "params": [ { - "description": "VM guest NIC secondary IP address for the port forwarding rule", + "description": "Description of the extension", "length": 255, - "name": "vmguestip", + "name": "description", "required": false, "type": "string" }, { - "description": "the public IP address ID for which static NAT feature is being enabled", + "description": "Only honored when type is Orchestrator. Whether prepare VM is needed or not", "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "name": "orchestratorrequirespreparevm", + "required": false, + "type": "boolean" }, { - "description": "the ID of the virtual machine for enabling static NAT feature", + "description": "The ID of the extension", "length": 255, - "name": "virtualmachineid", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "id", + "related": "listExtensions,updateExtension", "required": true, "type": "uuid" }, { - "description": "The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case)", + "description": "State of the extension", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "state", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "Optional boolean field, which indicates if details should be cleaned up or not (If set to true, details removed for this action, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" + }, + { + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", + "length": 255, + "name": "details", + "required": false, + "type": "map" } ], + "related": "listExtensions", "response": [ + {}, { "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", + "description": "Name of the extension", + "name": "name", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Deletes a Zone.", - "isasync": false, - "name": "deleteZone", - "params": [ + "description": "List of resources to which extension is registered to", + "name": "resources", + "response": [ + { + "description": "Type of the resource", + "name": "type", + "type": "string" + }, + { + "description": "the details of the resource map", + "name": "details", + "type": "map" + }, + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "type": "string" + }, + { + "description": "ID of the resource associated with the extension", + "name": "id", + "type": "string" + }, + { + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" + } + ], + "type": "list" + }, { - "description": "the ID of the Zone", - "length": 255, + "description": "ID of the extension", "name": "id", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The state of the extension", + "name": "state", "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", + "description": "Type of the extension", + "name": "type", + "type": "string" + }, + { + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" }, {}, - {} - ] + { + "description": "The details of the extension", + "name": "details", + "type": "map" + }, + { + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" + }, + { + "description": "The path of the entry point fo the extension", + "name": "path", + "type": "string" + }, + { + "description": "Description of the extension", + "name": "description", + "type": "string" + } + ], + "since": "4.21.0" }, { - "description": "Adds user to a project", - "isasync": true, - "name": "addUserToProject", + "description": "Updates an existing cluster", + "isasync": false, + "name": "updateCluster", "params": [ { - "description": "Project role type to be assigned to the user - Admin/Regular", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "roletype", + "name": "managedstate", "required": false, "type": "string" }, { - "description": "email ID of user to which invitation to the project is going to be sent", + "description": "hypervisor type of the cluster", "length": 255, - "name": "email", + "name": "clustertype", "required": false, "type": "string" }, { - "description": "Name of the user to be added to the project", + "description": "Details in key/value pairs to be added to the extension-resource mapping. Use the format externaldetails[i].=. Example: externaldetails[0].endpoint.url=https://example.com", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" }, { - "description": "ID of the project role", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "projectroleid", - "related": "", + "name": "allocationstate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "ID of the project to add the user to", + "description": "the ID of the Cluster", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "id", + "related": "addCluster,updateCluster", "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", + "description": "the cluster name", + "length": 255, + "name": "clustername", + "required": false, "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "hypervisor type of the cluster", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.14" - }, - { - "description": "Disables HA cluster-wide", - "isasync": true, - "name": "disableHAForCluster", - "params": [ - { - "description": "ID of the cluster", + "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" } ], + "related": "addCluster", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - } - ], - "since": "4.11" - }, - { - "description": "delete Tungsten-Fabric firewall policy", - "isasync": true, - "name": "deleteTungstenFabricFirewallPolicy", - "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", - "length": 255, - "name": "firewallpolicyuuid", - "required": true, + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" - } - ], - "response": [ + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" - } - ] - }, - { - "description": "Recovers a virtual machine.", - "isasync": false, - "name": "recoverVirtualMachine", - "params": [ + }, { - "description": "The ID of the virtual machine", - "length": 255, + "description": "the cluster ID", "name": "id", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the cluster name", + "name": "name", "type": "string" }, - {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the capacity of the Cluster", + "name": "capacity", + "response": [ + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "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 capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "The ID of extension for this cluster", + "name": "extensionid", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, + {}, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" - }, + } + ] + }, + { + "description": "Lists the VMs in a VMware Datacenter", + "isasync": false, + "name": "listVmwareDcVms", + "params": [ { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "length": 255, + "name": "vcenter", + "required": false, "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Name of the VM on vCenter. Must be set along with the hostname parameter", + "length": 255, + "name": "instancename", + "required": false, "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "The Username required to connect to resource.", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "The password for specified username.", + "length": 255, + "name": "password", + "required": false, + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "UUID of a linked existing vCenter", + "length": 255, + "name": "existingvcenterid", + "related": "", + "required": false, + "type": "uuid" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the host on vCenter. Must be set along with the instancename parameter", + "length": 255, + "name": "hostname", + "required": false, "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "Name of VMware datacenter.", + "length": 255, + "name": "datacentername", + "required": false, + "type": "string" + } + ], + "related": "listUnmanagedInstances", + "response": [ + { + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the list of nics associated with the virtual machine", + "name": "nic", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the type of the affinity group", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the name of the affinity group", - "name": "name", + "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 cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the affinity group", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "indicates the boot mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ + { + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "the file path of the disk image", + "name": "imagepath", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the ID of the disk", "name": "id", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the controller of the disk", + "name": "datastorehost", + "type": "string" + }, + { + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", "type": "string" + }, + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" } ], "type": "set" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "indicates the boot type", + "name": "boottype", + "type": "string" + }, + { + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", + "type": "string" + }, + { + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", + "type": "string" + }, + { + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" + }, + {}, + { + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" + }, + { + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "type": "string" + }, + {}, + { + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "the power state of the virtual machine", + "name": "powerstate", + "type": "string" + }, + { + "description": "the operating system ID of the virtual machine", + "name": "osid", + "type": "string" + }, + { + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", + "type": "string" + } + ] + }, + { + "description": "Lists storage providers.", + "isasync": false, + "name": "listStorageProviders", + "params": [ + { + "description": "the type of storage provider: either primary or image", + "length": 255, + "name": "type", + "required": true, + "type": "string" + }, + { + "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" + } + ], + "related": "", + "response": [ + { + "description": "the type of the storage provider: primary or image provider", + "name": "type", + "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": "the name of the storage provider", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "List profile in ucs manager", + "isasync": false, + "name": "listUcsProfiles", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the id for the ucs manager", + "length": 255, + "name": "ucsmanagerid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "related": "", + "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": "ucs profile dn", + "name": "ucsdn", + "type": "string" + } + ] + }, + { + "description": "This command allows the user to query the seceret and API keys for the account", + "isasync": false, + "name": "getUserKeys", + "params": [ + { + "description": "ID of the user whose keys are required", + "length": 255, + "name": "id", + "related": "disableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the api key of the registered user", + "name": "apikey", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "whether api key access is allowed or not", + "name": "apikeyaccess", + "type": "boolean" + }, + {}, + {}, + { + "description": "the secret key of the registered user", + "name": "secretkey", + "type": "string" + } + ], + "since": "4.10.0" + }, + { + "description": "update global load balancer rules.", + "isasync": true, + "name": "updateGlobalLoadBalancerRule", + "params": [ + { + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", + "required": false, "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the global load balancer rule", + "length": 255, + "name": "id", + "related": "updateGlobalLoadBalancerRule", + "required": true, + "type": "uuid" + }, + { + "description": "load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", + "length": 255, + "name": "gslblbmethod", + "required": false, "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "length": 255, + "name": "gslbstickysessionmethodname", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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": "customer associated with the tag", - "name": "customer", - "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" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, + {}, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the description of the global load balancer rule", + "name": "description", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "name of the global load balancer rule", + "name": "name", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "List of load balancer rules that are part of GSLB rule", + "name": "loadbalancerrule", "response": [ { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the project name of the load balancer", + "name": "project", "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", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", + "description": "is rule for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the list of resource tags associated with load balancer", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" } ], - "type": "set" + "type": "list" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, - {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" }, + {} + ] + }, + { + "description": "Lists host tags", + "isasync": false, + "name": "listHostTags", + "params": [ { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of the host tag", + "name": "name", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the ID of the host tag", + "name": "id", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if the host tag is implicit", + "name": "isimplicit", "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the host ID of the host tag", + "name": "hostid", + "type": "long" }, + {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Add a new guest OS type", + "isasync": true, + "name": "addGuestOs", + "params": [ + { + "description": "Unique display name for Guest OS", + "length": 255, + "name": "osdisplayname", + "required": true, "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "Map of (key/value pairs)", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "whether this guest OS is available for end users", + "length": 255, + "name": "forDisplay", + "required": false, + "type": "boolean" + }, + { + "description": "Optional name for Guest OS", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "ID of Guest OS category", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" + }, + {}, + { + "description": "the ID of the OS type", + "name": "id", "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", + "description": "the name/description of the OS type", + "name": "description", "type": "string" }, + {}, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "is the guest OS visible for the users", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the name of the OS category", + "name": "oscategoryname", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the OS category", + "name": "oscategoryid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the OS type", + "name": "name", + "type": "string" + } + ], + "since": "4.4.0" + }, + { + "description": "add an annotation.", + "isasync": false, + "name": "addAnnotation", + "params": [ + { + "description": "The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER", + "length": 255, + "name": "entitytype", + "required": false, + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the id of the entity to annotate", + "length": 255, + "name": "entityid", + "required": false, + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the annotation is visible for admins only", + "length": 255, + "name": "adminsonly", + "required": false, + "since": "4.16.0", + "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the annotation text", + "length": 255, + "name": "annotation", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + {}, + { + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", + "description": "The (uu)id of the user that entered the annotation", "name": "userid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" }, + {} + ], + "since": "4.11" + }, + { + "description": "Creates new NS Vpx", + "isasync": true, + "name": "deployNetscalerVpx", + "params": [ { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "The network this ip address should be associated to.", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "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": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "availability zone for the virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + } + ], + "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter", + "response": [ + { + "description": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "device state", + "name": "lbdevicestate", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" + }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" + }, + { + "description": "device capacity", + "name": "lbdevicecapacity", "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" + }, + {}, + { + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, + {}, + { + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" } ] }, { - "description": "upload an existing template into the CloudStack cloud. ", + "description": "Lists the volumes of elastistor", "isasync": false, - "name": "getUploadParamsForTemplate", + "name": "listElastistorVolume", "params": [ { - "description": "an optional accountName. Must be used with domainId.", + "description": "the ID of the account", "length": 255, - "name": "account", - "required": false, + "name": "id", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the name of the volume/template/iso", - "length": 255, + "description": "the name of the volume", "name": "name", - "required": true, "type": "string" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, + "description": "compression", + "name": "compression", "type": "string" }, + {}, { - "description": "true if this template requires HVM", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "description": "synchronization", + "name": "sync", + "type": "string" }, + {}, { - "description": "true if this template is a featured template, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "graceallowed", + "name": "graceallowed", "type": "string" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "deduplication", + "name": "deduplication", + "type": "string" + }, + { + "description": "the id of the volume", + "name": "id", + "type": "string" + } + ] + }, + { + "description": "add a baremetal pxe server", + "isasync": true, + "name": "addBaremetalPxeKickStartServer", + "params": [ + { + "description": "Pod Id", "length": 255, - "name": "ispublic", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", + "description": "the Physical Network ID", "length": 255, - "name": "ostypeid", + "name": "physicalnetworkid", "related": "", - "required": false, + "required": true, "type": "uuid" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "deployasis", - "required": false, - "since": "4.15.1", - "type": "boolean" + "name": "username", + "required": true, + "type": "string" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "type of pxe device", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "pxeservertype", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "name": "tftpdir", + "required": true, + "type": "string" }, { - "description": "Upload volume/template/iso for the project", + "description": "URL of the external pxe device", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "name": "url", + "required": true, + "type": "string" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" + "name": "password", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "device id of ", + "name": "id", + "type": "string" }, { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, + "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 the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "description": "Tftp root directory of PXE server", + "name": "tftpdir", + "type": "string" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "url", + "name": "url", "type": "string" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + {} + ] + }, + { + "description": "Lists Nicira NVP devices", + "isasync": false, + "name": "listNiciraNvpDevices", + "params": [ + { + "description": "List by keyword", "length": 255, - "name": "bits", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "", "length": 255, - "name": "isrouting", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "the Physical Network ID", "length": 255, - "name": "isdynamicallyscalable", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Template details in key/value pairs.", + "description": "", "length": 255, - "name": "details", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "nicira nvp device ID", "length": 255, - "name": "passwordenabled", + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", "required": false, - "type": "boolean" + "type": "uuid" } ], - "related": "getUploadParamsForIso", + "related": "addNiciraNvpDevice", "response": [ { - "description": "signature to be sent in the POST request.", - "name": "signature", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, + {}, + {}, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -105405,1275 +135518,2070 @@ var preCache = `{ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", + "type": "string" }, - {}, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" }, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "device name", + "name": "niciradevicename", + "type": "string" + }, + { + "description": "the transport zone Uuid", + "name": "transportzoneuuid", + "type": "string" + }, + { + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", + "type": "string" } - ], - "since": "4.6.0" + ] }, { - "description": "Resets network permissions.", + "description": "Lists all alerts.", "isasync": false, - "name": "resetNetworkPermissions", + "name": "listAlerts", "params": [ { - "description": "the network ID", + "description": "the ID of the alert", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", - "required": true, + "name": "id", + "related": "listAlerts", + "required": false, "type": "uuid" + }, + { + "description": "list by alert type", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "list by alert name", + "length": 255, + "name": "name", + "required": false, + "since": "4.3", + "type": "string" + }, + { + "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" } ], + "related": "", "response": [ - {}, + { + "description": "description of the alert", + "name": "description", + "type": "string" + }, + { + "description": "the date and time the alert was sent", + "name": "sent", + "type": "date" + }, + { + "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", + "description": "the id of the alert", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the alert", + "name": "name", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", + "name": "type", + "type": "short" }, + {}, {} - ], - "since": "4.17.0" + ] }, { - "description": "update Tungsten-Fabric loadbalancer health monitor", + "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", "isasync": true, - "name": "updateTungstenFabricLBHealthMonitor", + "name": "deployVirtualMachine", "params": [ { - "description": "loadbalancer health monitor expected code", - "length": 255, - "name": "expectedcode", + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", "required": false, + "since": "4.12", "type": "string" }, { - "description": "loadbalancer health monitor interval", - "length": 255, - "name": "interval", - "required": true, - "type": "integer" - }, - { - "description": "the ID of lb rule", + "description": "the ID of the Userdata", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", - "required": true, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18", "type": "uuid" }, { - "description": "loadbalancer health monitor url path", + "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", "length": 255, - "name": "urlpath", + "name": "rootdisksize", "required": false, - "type": "string" + "since": "4.4", + "type": "long" }, { - "description": "loadbalancer health monitor retry", + "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", "length": 255, - "name": "retry", - "required": true, - "type": "integer" + "name": "nicnetworklist", + "required": false, + "since": "4.15", + "type": "map" }, { - "description": "loadbalancer health monitor type", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "type", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "loadbalancer health monitor http method", + "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", "length": 255, - "name": "httpmethodtype", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "loadbalancer health monitor timeout", + "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", "length": 255, - "name": "timeout", - "required": true, - "type": "integer" - } - ], - "related": "", - "response": [ + "name": "iptonetworklist", + "required": false, + "type": "map" + }, { - "description": "the health monitor UUID", - "name": "uuid", - "type": "string" + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "length": 255, + "name": "details", + "required": false, + "since": "4.3", + "type": "map" }, { - "description": "the health monitor url path", - "name": "urlpath", + "description": "the ip address for default vm's network", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, - {}, { - "description": "the health monitor http method", - "name": "httpmethod", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "length": 255, + "name": "deploymentplanner", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "the health monitor ID", - "name": "id", - "type": "long" + "description": "Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200", + "length": 255, + "name": "datadisksdetails", + "required": false, + "since": "4.21.0", + "type": "map" }, { - "description": "the health monitor expected code", - "name": "expectedcode", - "type": "string" + "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the health monitor retry", - "name": "retry", - "type": "int" + "description": "", + "length": 255, + "name": "snapshotid", + "related": "copySnapshot,listSnapshots", + "required": false, + "since": "4.21", + "type": "uuid" }, { - "description": "the health monitor timeout", - "name": "timeout", - "type": "int" + "description": "", + "length": 255, + "name": "volumeid", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": false, + "since": "4.21", + "type": "uuid" }, { - "description": "the health monitor type", - "name": "type", + "description": "name of the ssh key pair used to login to the virtual machine", + "length": 255, + "name": "keypair", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", + "length": 255, + "name": "datadiskofferinglist", + "required": false, + "since": "4.11", + "type": "map" }, - {}, { - "description": "the health monitor interval", - "name": "interval", - "type": "int" + "description": "the mac address for default vm's network", + "length": 255, + "name": "macaddress", + "required": false, + "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Controls specific policies on IO", + "length": 255, + "name": "iodriverpolicy", + "required": false, "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": false, + "since": "4.13", + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "length": 255, + "name": "boottype", + "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Release the dedication for host", - "isasync": true, - "name": "releaseDedicatedHost", - "params": [ - { - "description": "the ID of the host", + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "required": true, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "since": "4.13", "type": "uuid" - } - ], - "response": [ + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "host name for the virtual machine", + "length": 255, + "name": "name", + "required": false, "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "length": 255, + "name": "bootmode", + "required": false, + "since": "4.14.0.0", + "type": "string" + }, + { + "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", + "length": 255, + "name": "iothreadsenabled", + "required": false, "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Accepts or declines project invitation", - "isasync": true, - "name": "updateProjectInvitation", - "params": [ + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" + }, { - "description": "id of the project to join", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "nicmultiqueuenumber", + "required": false, + "since": "4.18", + "type": "integer" + }, + { + "description": "availability zone for the virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "list invitations for specified account; this parameter has to be specified with domainId", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "token", + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", "length": 255, - "name": "userid", - "related": "createUser,enableUser,getUser", + "name": "overridediskofferingid", + "related": "", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "account that is joining the project", + "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", "length": 255, - "name": "account", + "name": "dhcpoptionsnetworklist", "required": false, - "type": "string" + "type": "map" }, { - "description": "if true, accept the invitation, decline if false. True by default", + "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", "length": 255, - "name": "accept", + "name": "securitygroupids", + "related": "", "required": false, - "type": "boolean" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "type": "list" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, + "name": "displayvm", + "required": false, + "since": "4.2", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", + "length": 255, + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "This is supposed to revert a volume snapshot. This command is only supported with KVM so far", - "isasync": true, - "name": "revertSnapshot", - "params": [ { - "description": "The ID of the snapshot", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "id", - "related": "revertSnapshot,listSnapshots", + "name": "size", + "required": false, + "type": "long" + }, + { + "description": "the ID of the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" - } - ], - "related": "listSnapshots", - "response": [ + }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "an optional group for the virtual machine", + "length": 255, + "name": "group", + "required": false, "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "length": 255, + "name": "keyboard", + "required": false, "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", - "type": "string" + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "length": 255, + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "list" }, { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" + "description": "names of the ssh key pairs used to login to the virtual machine", + "length": 255, + "name": "keypairs", + "required": false, + "since": "4.17", + "type": "list" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "an optional user generated name for the virtual machine", + "length": 255, + "name": "displayname", + "required": false, "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" + "description": "Deploy vm for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" + "description": "true if start vm after creating; defaulted to true if not specified", + "length": 255, + "name": "startvm", + "required": false, + "type": "boolean" }, { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" + "description": "Number of days instance is leased for.", + "length": 255, + "name": "leaseduration", + "required": false, + "since": "4.21.0", + "type": "integer" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "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, "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "length": 255, + "name": "affinitygroupids", + "related": "", + "required": false, + "type": "list" }, - {}, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the ipv6 address for default vm's network", + "length": 255, + "name": "ip6address", + "required": false, "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "length": 255, + "name": "password", + "required": false, + "since": "4.19.0.0", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "Enable packed virtqueues or not.", + "length": 255, + "name": "nicpackedvirtqueuesenabled", + "required": false, + "since": "4.18", + "type": "boolean" + }, + { + "description": "true if virtual machine needs to be dynamically scalable", + "length": 255, + "name": "dynamicscalingenabled", + "required": false, + "since": "4.16", + "type": "boolean" + }, + { + "description": "used to specify the vApp properties.", + "length": 255, + "name": "properties", + "required": false, + "since": "4.15", + "type": "map" + }, + { + "description": "Lease expiry action, valid values are STOP and DESTROY", + "length": 255, + "name": "leaseexpiryaction", + "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", + "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "length": 255, + "name": "securitygroupnames", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "length": 255, + "name": "affinitygroupnames", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "length": 255, + "name": "copyimagetags", + "required": false, + "since": "4.13", "type": "boolean" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18", "type": "map" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" + } + ], + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + {}, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "name of the snapshot", - "name": "name", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the account associated with the tag", + "description": "the account owning the affinity group", "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, - {}, { - "description": "the status of the template", - "name": "status", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "User VM type", + "name": "vmtype", "type": "string" - } - ] - }, - { - "description": "Updates a condition for VM auto scaling", - "isasync": true, - "name": "updateCondition", - "params": [ + }, { - "description": "the ID of the condition.", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, + {}, { - "description": "Value for which the Counter will be evaluated with the Operator selected.", - "length": 255, - "name": "threshold", - "required": true, + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", - "length": 255, - "name": "relationaloperator", - "required": true, + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" - } - ], - "response": [ + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" - } - ], - "since": "4.18.0" - }, - { - "description": "Lists Regions", - "isasync": false, - "name": "listRegions", - "params": [ + }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "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": "List Region by region name.", - "length": 255, - "name": "name", - "required": false, + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "List Region by region ID.", - "length": 255, - "name": "id", - "required": false, - "type": "integer" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" - } - ], - "related": "addRegion", - "response": [ + }, { - "description": "the end point of the region", - "name": "endpoint", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the region", - "name": "name", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "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 region", - "name": "id", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" - } - ] - }, - { - "description": "Configures an Internal Load Balancer element.", - "isasync": true, - "name": "configureInternalLoadBalancerElement", - "params": [ + }, { - "description": "the ID of the internal lb provider", - "length": 255, - "name": "id", - "related": "configureInternalLoadBalancerElement", - "required": true, - "type": "uuid" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "Enables/Disables the Internal Load Balancer element", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - } - ], - "related": "", - "response": [ + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "the id of the internal load balancer element", - "name": "id", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the physical network service provider id of the element", - "name": "nspid", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, - {} - ], - "since": "4.2.0" - }, - { - "description": "Attempts Migration of a system virtual machine to the host specified.", - "isasync": true, - "name": "migrateSystemVm", - "params": [ { - "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", - "length": 255, - "name": "autoselect", - "required": false, - "since": "4.16.0", - "type": "boolean" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "destination Host ID to migrate VM to", - "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "migrateSystemVm", - "required": true, - "type": "uuid" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "since": "4.16.0", - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "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 gateway for the system VM", - "name": "gateway", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "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" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "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" + } + ], + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "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": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "security group name", + "name": "securitygroupname", + "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": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, + {}, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + } + ], + "type": "set" }, - {}, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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 second DNS for the system VM", - "name": "dns2", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "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" + } + ], + "type": "set" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the control state of the host for the system VM", + "description": "the control state of the host for the virtual machine", "name": "hostcontrolstate", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the name of the virtual machine", + "name": "name", "type": "string" + } + ] + }, + { + "description": "Lists all volumes.", + "isasync": false, + "name": "listVolumes", + "params": [ + { + "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": "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": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the Zone ID for the system VM", + "description": "the ID of the availability zone", + "length": 255, "name": "zoneid", - "type": "string" + "related": "listZones", + "required": false, + "type": "uuid" }, - {}, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "listsystemvms", + "required": false, + "since": "4.18", + "type": "boolean" }, { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" }, { - "description": "the state of the system VM", - "name": "state", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" - } - ] - }, - { - "description": "List the counters for VM auto scaling", - "isasync": false, - "name": "listCounters", - "params": [ - { - "description": "Source of the counter.", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "source", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, + "since": "4.3", "type": "string" }, { - "description": "Name of the counter.", + "description": "list volumes by disk offering", "length": 255, - "name": "name", + "name": "diskofferingid", + "related": "", "required": false, - "type": "string" + "since": "4.4", + "type": "uuid" }, { - "description": "List by keyword", + "description": "the ID of the disk volume", "length": 255, - "name": "keyword", + "name": "id", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", "length": 255, - "name": "pagesize", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "integer" + "since": "4.19.1", + "type": "uuid" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "page", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "ID of the Counter.", + "description": "the pod id the disk volume belongs to", "length": 255, - "name": "id", - "related": "createCounter,listCounters", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "Network provider of the counter.", + "description": "the type of disk volume", "length": 255, - "name": "provider", + "name": "type", "required": false, - "since": "4.18.0", - "type": "string" - } - ], - "related": "createCounter", - "response": [ - { - "description": "Provider of the counter.", - "name": "provider", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Value in case of snmp or other specific counters.", - "name": "value", - "type": "string" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "displayvolume", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "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": "zone id of counter", - "name": "zoneid", - "type": "string" + "description": "the IDs of the volumes, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": false, + "since": "4.9", + "type": "list" }, - {}, { - "description": "Source of the counter.", - "name": "source", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "Name of the counter.", + "description": "the name of the disk volume", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "the id of the Counter", - "name": "id", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, - {} - ] - }, - { - "description": "remove Tungsten-Fabric tag", - "isasync": true, - "name": "removeTungstenFabricTag", - "params": [ { - "description": "the uuid of nics", + "description": "", "length": 255, - "name": "nicuuid", + "name": "page", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "policyuuid", + "name": "clusterid", + "related": "addCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of zone", + "description": "list only volumes that are encrypted", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "name": "isencrypted", + "required": false, + "since": "4.19.1", + "type": "boolean" }, { - "description": "the uuid of Tungsten-Fabric tag", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "taguuid", - "required": true, - "type": "string" + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the uuid of networks", + "description": "the ID of the virtual machine", "length": 255, - "name": "networkuuid", + "name": "virtualmachineid", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "list volumes on specified host", "length": 255, - "name": "applicationpolicysetuuid", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the uuid of vms", + "description": "", "length": 255, - "name": "vmuuid", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" } ], - "related": "createTungstenFabricTag", + "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ - {}, - { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" - }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, - {}, { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" - } - ] - }, - { - "description": "Lists all available virtual router elements.", - "isasync": false, - "name": "listVirtualRouterElements", - "params": [ - { - "description": "list virtual router elements by id", - "length": 255, - "name": "id", - "related": "listVirtualRouterElements", - "required": false, - "type": "uuid" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "list network offerings by enabled state", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "list virtual router elements by network service provider id", - "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, {}, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { @@ -106682,363 +137590,368 @@ var preCache = `{ "type": "integer" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the path of the volume", + "name": "path", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" - } - ] - }, - { - "description": "Deletes snapshot policies for the account.", - "isasync": false, - "name": "deleteSnapshotPolicies", - "params": [ + }, { - "description": "the Id of the snapshot policy", - "length": 255, - "name": "id", - "related": "updateSnapshotPolicy", - "required": false, - "type": "uuid" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "list of snapshots policy IDs separated by comma", - "length": 255, - "name": "ids", - "related": "updateSnapshotPolicy", - "required": false, - "type": "list" - } - ], - "response": [ + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists implementors of implementor of a network traffic type or implementors of all network traffic types", - "isasync": false, - "name": "listTrafficTypeImplementors", - "params": [ + "description": "the status of the volume", + "name": "status", + "type": "string" + }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", - "length": 255, - "name": "traffictype", - "required": false, + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "implementor of network traffic type", - "name": "traffictypeimplementor", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, - {}, { - "description": "network traffic type", - "name": "traffictype", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "link a cloudstack account to a group or OU in ldap", - "isasync": false, - "name": "linkAccountToLdap", - "params": [ + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, { - "description": "name of the account, it will be created if it does not exist", - "length": 255, - "name": "account", - "required": true, + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "name of the group or OU in LDAP", - "length": 255, - "name": "ldapdomain", - "required": true, + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "domain admin username in LDAP ", - "length": 255, - "name": "admin", - "required": false, + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "type of the ldap name. GROUP or OU, defaults to GROUP", - "length": 255, - "name": "type", - "required": false, + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "The id of the domain that is to contain the linked account.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": true, - "type": "uuid" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", - "length": 255, - "name": "accounttype", - "required": true, - "type": "integer" - } - ], - "related": "", - "response": [ + "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": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "Domain Admin accountId that is created", - "name": "accountid", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "Type of the account to auto import", - "name": "accounttype", - "type": "int" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "type of the name in LDAP which is linked to the domain", - "name": "type", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.11.0" - }, - { - "description": "list the db hosts and statistics", - "isasync": false, - "name": "listDbMetrics", - "params": [], - "related": "", - "response": [ + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, { - "description": "the tls versions currently in use (accepted) by the DB", - "name": "tlsversions", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the last measured load averages on the DB", - "name": "dbloadaverages", - "type": "double[]" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the version of the currently running DB", - "name": "version", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, - {}, { - "description": "the state of the usage server", - "name": "replicas", - "type": "string[]" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "the number of connections to the DB", - "name": "connections", - "type": "int" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, - {}, { - "description": "the version of the currently running DB", - "name": "versioncomment", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the number of queries performed on the DB", - "name": "queries", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "the uptime of the DB in seconds", - "name": "uptime", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "the name of the active usage server", - "name": "hostname", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" } - ], - "since": "4.17.0" + ] }, { - "description": "Deletes an image store or Secondary Storage.", + "description": "Removes a Management Server.", "isasync": false, - "name": "deleteImageStore", + "name": "removeManagementServer", "params": [ { - "description": "The image store ID or Secondary Storage ID.", + "description": "the ID of the Management Server", "length": 255, "name": "id", - "related": "listSwifts,addImageStoreS3,listImageStores", + "related": "", "required": true, "type": "uuid" } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "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.2.0" + ] }, { - "description": "Lists autoscale vm profiles.", - "isasync": false, - "name": "listAutoScaleVmProfiles", + "description": "Creates a load balancer health check policy", + "isasync": true, + "name": "createLBHealthCheckPolicy", "params": [ { - "description": "", + "description": "HTTP ping path", "length": 255, - "name": "page", + "name": "pingpath", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, "name": "fordisplay", "required": false, @@ -107046,176 +137959,127 @@ var preCache = `{ "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "availability zone for the auto deployed virtual machine", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "since": "4.4", - "type": "uuid" - }, - { - "description": "the otherdeployparameters of the autoscale vm profile", - "length": 255, - "name": "otherdeployparams", - "required": false, - "type": "string" - }, - { - "description": "list profiles by service offering id", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "since": "4.4", - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "the description of the load balancer health check policy", "length": 255, - "name": "keyword", + "name": "description", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "responsetimeout", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the load balancer rule", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, + "name": "lbruleid", + "related": "", + "required": true, "type": "uuid" }, { - "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" - }, - { - "description": "the templateid of the autoscale vm profile", + "description": "Amount of time between health checks (1 sec - 20940 sec)", "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "intervaltime", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the autoscale vm profile", + "description": "Number of consecutive health check success before declaring an instance healthy", "length": 255, - "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", + "name": "healthythreshold", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Number of consecutive health check failures before declaring an instance unhealthy", "length": 255, - "name": "isrecursive", + "name": "unhealthythreshold", "required": false, - "type": "boolean" + "type": "integer" } ], - "related": "createAutoScaleVmProfile", + "related": "", "response": [ - {}, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" - }, { - "description": "the autoscale vm profile ID", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the vm profile", - "name": "domainid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" }, - {}, - { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" - }, { - "description": "the account owning the instance group", - "name": "account", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the domain of the HealthCheck policy", + "name": "domain", "type": "string" }, {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the list of healthcheckpolicies", + "name": "healthcheckpolicy", + "response": [ + { + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" + }, + { + "description": "the description of the healthcheck policy", + "name": "description", + "type": "string" + }, + { + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", + "type": "string" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" + }, + { + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" + }, + { + "description": "the LB HealthCheck policy ID", + "name": "id", + "type": "string" + } + ], + "type": "list" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" }, { @@ -107224,1631 +138088,1486 @@ var preCache = `{ "type": "integer" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", - "type": "string" - }, - { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" - }, - {}, - { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", "type": "string" }, - { - "description": "Base 64 encoded VM user data", - "name": "userdata", - "type": "string" - } - ] + {} + ], + "since": "4.2.0" }, { - "description": "Disables out-of-band management for a host", + "description": "Change Service offering of a Shared FileSystem", "isasync": true, - "name": "disableOutOfBandManagementForHost", + "name": "changeSharedFileSystemServiceOffering", "params": [ { - "description": "the ID of the host", + "description": "the offering to use for the shared filesystem instance", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "required": true, "type": "uuid" } ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", "response": [ { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" }, { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, - {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, - {}, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, { - "description": "the operation result description", - "name": "description", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "Cancel host status from 'Degraded'. Host will transit back to status 'Enabled'.", - "isasync": true, - "name": "cancelHostAsDegraded", - "params": [ - { - "description": "host ID", - "length": 255, - "name": "id", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "related": "reconnectHost,addBaremetalHost", - "response": [ - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" }, + {}, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" }, + {}, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "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": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", "type": "boolean" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + }, + { + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "GPU cards present in the host", - "name": "gpugroupname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "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 Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - } - ], + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "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": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "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" } ], "type": "list" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" }, - {}, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Locks a user account", + "isasync": false, + "name": "lockUser", + "params": [ + { + "description": "Locks user by user ID.", + "length": 255, + "name": "id", + "related": "disableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" + } + ], + "related": "disableUser,getUser,listUsers", + "response": [ + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the type of the role", + "name": "roletype", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the host version", - "name": "version", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, + {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "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 source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" }, + {}, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "events available for the host", - "name": "events", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the user lastname", + "name": "lastname", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the user firstname", + "name": "firstname", "type": "string" - }, + } + ] + }, + { + "description": "Checks if the Cloudian Connector is enabled", + "isasync": false, + "name": "cloudianIsEnabled", + "params": [], + "related": "", + "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Cloudian Management Console base URL", + "name": "url", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the Cloudian connector enabled state", + "name": "enabled", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "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" - } + {}, + {} ], - "since": "4.16.0.0" + "since": "4.11.0" }, { - "description": "Authorizes a particular ingress rule for this security group", - "isasync": true, - "name": "authorizeSecurityGroupIngress", + "description": "Creates a network", + "isasync": false, + "name": "createNetwork", "params": [ { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, - { - "description": "start port for this ingress rule", + "description": "the ID or VID of the network", "length": 255, - "name": "startport", + "name": "vlan", "required": false, - "type": "integer" + "type": "string" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup", + "name": "gateway", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "end port for this ingress rule", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "endport", + "name": "publicmtu", "required": false, + "since": "4.18.0", "type": "integer" }, { - "description": "an optional project of the security group", + "description": "an optional project for the network", "length": 255, "name": "projectid", - "related": "activateProject,suspendProject", + "related": "", "required": false, "type": "uuid" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.", + "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", "length": 255, - "name": "protocol", + "name": "endip", "required": false, "type": "string" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "network domain", "length": 255, - "name": "securitygroupname", + "name": "networkdomain", "required": false, "type": "string" }, { - "description": "error code for this icmp message", + "description": "the first IPv4 DNS for the network", "length": 255, - "name": "icmpcode", + "name": "dns1", "required": false, - "type": "integer" + "since": "4.18.0", + "type": "string" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "ID of the network in an external system.", "length": 255, - "name": "account", + "name": "externalid", "required": false, "type": "string" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "the zone ID for the network", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "type of the icmp message being sent", + "description": "the network offering ID", "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "name": "networkofferingid", + "related": "listNetworkOfferings", + "required": true, + "type": "uuid" }, { - "description": "user to security group mapping", + "description": "the display text of the network", "length": 255, - "name": "usersecuritygrouplist", + "name": "displaytext", "required": false, - "type": "map" - } - ], - "related": "", - "response": [ + "type": "string" + }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the name of the network", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "IPV4 address to be assigned to a router in a shared network", + "length": 255, + "name": "routerip", + "required": false, + "since": "4.16", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the ending IPv6 address in the IPv6 network range", + "length": 255, + "name": "endipv6", + "required": false, + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the gateway of the IPv6 network. Required for Shared networks", + "length": 255, + "name": "ip6gateway", + "required": false, "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.", + "length": 255, + "name": "cidrsize", + "required": false, + "since": "4.20.0", "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "length": 255, + "name": "hideipaddressusage", + "required": false, + "type": "boolean" }, { - "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": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" + "description": "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "length": 255, + "name": "sourcenatipaddress", + "required": false, + "since": "4.19", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", + "length": 255, + "name": "bypassvlanoverlapcheck", + "required": false, + "type": "boolean" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the CIDR of IPv6 network, must be at least /64", + "length": 255, + "name": "ip6cidr", + "required": false, "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "Ids of the Bgp Peer for the network", + "length": 255, + "name": "bgppeerids", + "related": "", + "required": false, + "since": "4.20.0", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the VPC network belongs to", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, - {}, { - "description": "account owning the security group rule", - "name": "account", + "description": "The network this network is associated to. only available if create a Shared network", + "length": 255, + "name": "associatednetworkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "since": "4.17.0", + "type": "uuid" + }, + { + "description": "the beginning IPv6 address in the IPv6 network range", + "length": 255, + "name": "startipv6", + "required": false, "type": "string" - } - ] - }, - { - "description": "Sync storage pool with management server (currently supported for Datastore Cluster in VMware and syncs the datastores in it)", - "isasync": true, - "name": "syncStoragePool", - "params": [ + }, { - "description": "Storage pool id", + "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": true, - "type": "uuid" - } - ], - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", - "response": [ + "name": "netmask", + "required": false, + "type": "string" + }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the isolated private VLAN type for this network", + "length": 255, + "name": "isolatedpvlantype", + "required": false, "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the first IPv6 DNS for the network", + "length": 255, + "name": "ip6dns1", + "required": false, + "since": "4.18.0", + "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "IPV6 address to be assigned to a router in a shared network", + "length": 255, + "name": "routeripv6", + "required": false, + "since": "4.16", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field, whether to the display the network to the end user or not.", + "length": 255, + "name": "displaynetwork", + "required": false, "type": "boolean" }, - {}, { - "description": "the storage pool type", - "name": "type", + "description": "the beginning IP address in the network IP range", + "length": 255, + "name": "startip", + "required": false, "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified", + "length": 255, + "name": "subdomainaccess", + "required": false, + "type": "boolean" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the physical network ID the network belongs to", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric virtual router the network belongs to", + "length": 255, + "name": "tungstenvirtualrouteruuid", + "required": false, + "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "Account that will own the network. Account should be under the selected domain", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the second IPv6 DNS for the network", + "length": 255, + "name": "ip6dns2", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "Network ACL ID associated for the network", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList", + "required": false, + "type": "uuid" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "MTU to be configured on the network VR's private interface(s)", + "length": 255, + "name": "privatemtu", + "required": false, + "since": "4.18.0", + "type": "integer" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the AS Number of the network", + "length": 255, + "name": "asnumber", + "required": false, + "since": "4.20.0", "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the second IPv4 DNS for the network", + "length": 255, + "name": "dns2", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the isolated private VLAN for this network", + "length": 255, + "name": "isolatedpvlan", + "required": false, "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network", + "length": 255, + "name": "acltype", + "required": false, "type": "string" - }, + } + ], + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "response": [ { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "AS NUMBER", + "name": "asnumber", "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, - {}, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "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 total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, + {}, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" - } - ], - "since": "4.15.1" - }, - { - "description": "Creates a security group", - "isasync": false, - "name": "createSecurityGroup", - "params": [ + }, { - "description": "an optional account for the security group. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "name of the security group", - "length": 255, - "name": "name", - "required": true, + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "Create security group for project", - "length": 255, + "description": "the project id of the ipaddress", "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, - { - "description": "the description of the security group", - "length": 255, - "name": "description", - "required": false, "type": "string" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "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 value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, - {}, { - "description": "the name of the security group", - "name": "name", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, + {}, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "the list of services", + "name": "service", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "tag value", + "description": "the capability value", "name": "value", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], - "type": "set" + "type": "list" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the service name", + "name": "name", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "List network visibility and all accounts that have permissions to view this network.", - "isasync": false, - "name": "listNetworkPermissions", - "params": [ - { - "description": "Lists network permission by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the name of the domain to which the network belongs", - "name": "domain", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of project the network is available for", - "name": "projectid", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project the network is available for", - "name": "project", + "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 account the network is available for", - "name": "account", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the ID of the domain to which the network belongs", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of account the network is available for", - "name": "accountid", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the network ID", - "name": "networkid", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.17.0" - }, - { - "description": "Updates Bucket properties", - "isasync": false, - "name": "updateBucket", - "params": [ - { - "description": "Bucket Quota in GB", - "length": 255, - "name": "quota", - "required": false, - "type": "integer" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "Bucket Access Policy", - "length": 255, - "name": "policy", - "required": false, + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "The ID of the Bucket", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "Enable/Disable Bucket encryption", - "length": 255, - "name": "encryption", - "required": false, - "type": "boolean" - }, - { - "description": "Enable/Disable Bucket Versioning", - "length": 255, - "name": "versioning", - "required": false, - "type": "boolean" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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" - } - ], - "since": "4.19.0" - }, - { - "description": "Recalculate and update resource count for an account or domain.", - "isasync": false, - "name": "updateResourceCount", - "params": [ { - "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - 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. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", - "length": 255, - "name": "resourcetype", - "required": false, + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", "type": "integer" }, { - "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": true, - "type": "uuid" - }, - { - "description": "Update resource count for a specified account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "Update resource limits for project", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the project name for which resource count's are updated", - "name": "project", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the account for which resource count's are updated", - "name": "account", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, - { - "description": "resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the domain name for which resource count's are updated", - "name": "domain", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the project id for which resource count's are updated", - "name": "projectid", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the domain ID for which resource count's are updated", - "name": "domainid", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "resource count", - "name": "resourcecount", - "type": "long" - } - ] - }, - { - "description": "Lists site 2 site vpn gateways", - "isasync": false, - "name": "listVpnGateways", - "params": [ - { - "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, + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "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": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "id of the vpn gateway", - "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways", - "required": false, - "type": "uuid" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the 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 project id the tag belongs to", + "name": "projectid", + "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" + } + ], + "type": "list" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "id of vpc", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", - "required": false, - "type": "uuid" + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" }, { - "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, + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "createVpnGateway", - "response": [ + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, { - "description": "the owner", - "name": "account", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, - {}, { - "description": "the project id", - "name": "projectid", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, - {}, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the project name", - "name": "project", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "the owner of the network", + "name": "account", "type": "string" }, { @@ -108857,146 +139576,146 @@ var preCache = `{ "type": "integer" }, { - "description": "the vpn gateway ID", + "description": "the id of the network", "name": "id", "type": "string" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" } ] }, { - "description": "Lists dynamic roles in CloudStack", + "description": "Lists all available network offerings.", "isasync": false, - "name": "listRoles", + "name": "listNetworkOfferings", "params": [ { - "description": "", + "description": "the network offering can be used only for network creation inside the VPC", "length": 255, - "name": "page", + "name": "forvpc", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "description": "list network offerings by name", "length": 255, - "name": "type", + "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List role by role name.", + "description": "the tags for the network offering.", "length": 255, - "name": "name", + "name": "specifyvlan", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List role by role ID.", + "description": "list network offerings by state", "length": 255, - "name": "id", - "related": "importRole,listRoles", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.", "length": 255, - "name": "keyword", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "string" - } - ], - "related": "importRole", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "type": "uuid" }, { - "description": "the type of the role", - "name": "type", - "type": "string" + "description": "true if need to list only network offerings which support specifying ip ranges", + "length": 255, + "name": "specifyipranges", + "required": false, + "type": "boolean" }, { - "description": "the ID of the role", - "name": "id", + "description": "list network offerings by tags", + "length": 4096, + "name": "tags", + "required": false, "type": "string" }, { - "description": "true if role is default, false otherwise", - "name": "isdefault", + "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", + "length": 255, + "name": "sourcenatsupported", + "required": false, "type": "boolean" }, { - "description": "the name of the role", - "name": "name", - "type": "string" + "description": "list network offerings supporting certain services", + "length": 255, + "name": "supportedservices", + "required": false, + "type": "list" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list network offerings available for network creation in specific zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the description of the role", - "name": "description", + "description": "list network offerings by guest type: shared or isolated", + "length": 255, + "name": "guestiptype", + "required": false, "type": "string" - }, - { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" - } - ], - "since": "4.9.0" - }, - { - "description": "list Tungsten-Fabric policy", - "isasync": false, - "name": "listTungstenFabricPolicy", - "params": [ + }, { - "description": "List by keyword", + "description": "true if need to list only default network offerings. Default value is false", "length": 255, - "name": "keyword", + "name": "isdefault", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of ip address", + "description": "list network offerings available for network creation in specific domain", "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "domainid", + "related": "listDomains", "required": false, + "since": "4.13", "type": "uuid" }, { - "description": "the ID of zone", + "description": "list network offerings by display text", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of network", + "description": "list network offerings by ID", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "listNetworkOfferings", "required": false, "type": "uuid" }, @@ -109008,724 +139727,797 @@ var preCache = `{ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "true if offering has tags specified", "length": 255, - "name": "policyuuid", + "name": "istagged", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "the availability of network offering. Default value is required", "length": 255, - "name": "page", + "name": "availability", "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, - {}, - { - "description": "Tungsten-Fabric policy name", - "name": "name", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - } - ] - }, - { - "description": "Download object at a specified path on an image store.", - "isasync": true, - "name": "downloadImageStoreObject", - "params": [ { - "description": "path to download on image store", + "description": "list by traffic type", "length": 255, - "name": "path", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "id of the image store", + "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "id", - "related": "listSwifts,addImageStoreS3,listImageStores", - "required": true, - "type": "uuid" + "name": "routingmode", + "required": false, + "since": "4.20.0", + "type": "string" } ], - "related": "extractTemplate", + "related": "", "response": [ { - "description": "the state of the extracted object", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", - "type": "string" + "description": "the date this network offering was created", + "name": "created", + "type": "date" }, { - "description": "the id of extracted object", - "name": "id", - "type": "string" + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" }, { - "description": "the name of the extracted object", - "name": "name", - "type": "string" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" }, { - "description": "zone ID the object was extracted from", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "zoneid", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" }, { - "description": "", - "name": "resultstring", - "type": "string" + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the status of the extraction", - "name": "status", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" }, { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" - }, - { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, - {}, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Retrieves a cloud identifier.", - "isasync": false, - "name": "getCloudIdentifier", - "params": [ + }, { - "description": "the user ID for the cloud identifier", - "length": 255, - "name": "userid", - "related": "createUser,enableUser,getUser", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { - "description": "the cloud identifier", - "name": "cloudidentifier", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", + "type": "boolean" }, { - "description": "the signed response for the cloud identifier", - "name": "signature", - "type": "string" + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "the user ID for the cloud identifier", - "name": "userid", - "type": "string" + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" }, - {} - ] - }, - { - "description": "Creates a load balancer stickiness policy ", - "isasync": true, - "name": "createLBStickinessPolicy", - "params": [ { - "description": "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", - "length": 255, - "name": "methodname", - "required": true, + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "name of the load balancer stickiness policy", - "length": 255, - "name": "name", - "required": true, + "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 ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", - "required": true, - "type": "uuid" - }, - { - "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", - "length": 255, - "name": "param", - "required": false, - "type": "map" - }, - { - "description": "the description of the load balancer stickiness policy", - "length": 255, - "name": "description", - "required": false, + "description": "the id of the network offering", + "name": "id", "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", + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" - } - ], - "related": "listLBStickinessPolicies", - "response": [ - { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", - "response": [ - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the params of the policy", - "name": "params", - "type": "map" - }, - { - "description": "the method name of the Stickiness policy", - "name": "methodname", - "type": "string" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the LB Stickiness policy ID", - "name": "id", - "type": "string" - } - ], - "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" }, - {}, + { + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, - {}, { - "description": "the state of the policy", - "name": "state", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" + "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": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "the account of the Stickiness policy", - "name": "account", - "type": "string" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" } - ], - "since": "3.0.0" + ] }, { - "description": "Adds a Cisco Asa 1000v appliance", + "description": "Lists dedicated pods.", "isasync": false, - "name": "addCiscoAsa1000vResource", + "name": "listDedicatedPods", "params": [ { - "description": "the Cluster ID", + "description": "List by keyword", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "description": "", "length": 255, - "name": "hostname", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the Physical Network ID", + "description": "the ID of the pod", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, "type": "uuid" }, { - "description": "Nexus port profile associated with inside interface of ASA 1000v", + "description": "the name of the account associated with the pod. Must be used with domainId.", "length": 255, - "name": "insideportprofile", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "name": "account", + "required": false, "type": "string" }, - {}, - {}, - {}, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list dedicated pods by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" }, - {}, - {} - ] - }, - { - "description": "Configures a Palo Alto firewall device", - "isasync": true, - "name": "configurePaloAltoFirewall", - "params": [ { - "description": "capacity of the firewall device, Capacity will be interpreted as number of networks device can handle", + "description": "the ID of the domain associated with the pod", "length": 255, - "name": "fwdevicecapacity", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "Palo Alto firewall device ID", + "description": "", "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" } ], - "related": "addPaloAltoFirewall,listPaloAltoFirewalls", + "related": "", "response": [ { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" - }, - { - "description": "device name", - "name": "fwdevicename", - "type": "string" - }, - { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the ID of the Pod", + "name": "podid", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "device state", - "name": "fwdevicestate", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the Name of the Pod", + "name": "podname", "type": "string" }, + {}, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the username that's used to log in to the external firewall", - "name": "username", - "type": "string" - }, + } + ] + }, + { + "description": "Lists VPCs", + "isasync": false, + "name": "listVPCs", + "params": [ { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list by ID of the VPC offering", + "length": 255, + "name": "vpcofferingid", + "related": "updateVPCOffering", + "required": false, + "type": "uuid" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "list VPC by id", + "length": 255, + "name": "id", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "length": 255, + "name": "cidr", + "required": false, "type": "string" }, - {}, { - "description": "the private security zone of the external firewall", - "name": "privatezone", - "type": "string" + "description": "list VPC supporting certain services", + "length": 255, + "name": "supportedservices", + "required": false, + "type": "list" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", - "type": "string" - } - ] - }, - { - "description": "Updates ACL item with specified ID", - "isasync": true, - "name": "updateNetworkACLItem", - "params": [ - { - "description": "the ID of the network ACL item", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "updateNetworkACLItem,moveNetworkAclItem", - "required": true, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "the starting port of ACL", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "startport", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "type of the ICMP message being sent", + "description": "", "length": 255, - "name": "icmptype", + "name": "page", "required": false, "type": "integer" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "list VPCs by restartRequired option", "length": 255, - "name": "protocol", + "name": "restartrequired", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "cidrlist", + "name": "fordisplay", "required": false, - "type": "list" + "since": "4.4", + "type": "boolean" }, { - "description": "The network of the vm the ACL will be created for", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "number", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "list by name of the VPC", "length": 255, - "name": "customid", + "name": "name", "required": false, - "since": "4.4", "type": "string" }, { - "description": "scl entry action, allow or deny", + "description": "", "length": 255, - "name": "action", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", + "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": "traffictype", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "A description indicating why the ACL rule is required.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "reason", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'.", + "description": "list by zone", "length": 255, - "name": "partialupgrade", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ending port of ACL", + "description": "List by display text of the VPC", "length": 255, - "name": "endport", + "name": "displaytext", "required": false, - "type": "integer" + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "fordisplay", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "error code for this ICMP message", + "description": "list VPCs by state", "length": 255, - "name": "icmpcode", + "name": "state", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "flag to display the resource icon for VPCs", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" } ], - "related": "moveNetworkAclItem", + "related": "createVPC,listVPCs,updateVPC", "response": [ { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the id of the VPC", + "name": "id", + "type": "string" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "the state of the rule", + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" + }, + { + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, + { + "description": "the project name of the VPC", + "name": "project", + "type": "string" + }, + { + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "state of the VPC. Can be Inactive/Enabled", "name": "state", "type": "string" }, + { + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the owner of the VPC", + "name": "account", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + {}, + { + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "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": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "the list of resource tags associated with the network ACLs", + "description": "the name of the VPC", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -109733,390 +140525,549 @@ var preCache = `{ "name": "value", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, - {}, - {}, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "the cidr the VPC", + "name": "cidr", + "type": "string" + }, + { + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, + { + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + } + ] + }, + { + "description": "Execute network-utility command (ping/arping/tracert) on system VMs remotely", + "isasync": true, + "name": "runDiagnostics", + "params": [ + { + "description": "The ID of the system VM instance to diagnose", + "length": 255, + "name": "targetid", + "related": "startSystemVm", + "required": true, + "type": "uuid" + }, + { + "description": "The IP/Domain address to test connection to", + "length": 255, + "name": "ipaddress", + "required": true, "type": "string" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "Additional command line options that apply for each command", + "length": 255, + "name": "params", + "required": false, "type": "string" }, { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, + "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", + "length": 255, + "name": "type", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the standard error output from the command execution", + "name": "stderr", "type": "string" }, + {}, + {}, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the standard output from the command execution", + "name": "stdout", + "type": "string" + }, + { + "description": "the command execution return code", + "name": "exitcode", + "type": "string" } - ] + ], + "since": "4.12.0.0" }, { - "description": "Moves a user to another account", + "description": "Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer", "isasync": false, - "name": "moveUser", + "name": "addNetworkDevice", "params": [ { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", "length": 255, - "name": "account", + "name": "networkdevicetype", "required": false, "type": "string" }, { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", + "description": "parameters for network device", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", + "name": "networkdeviceparameterlist", "required": false, - "type": "uuid" - }, - { - "description": "id of the user to be deleted", - "length": 255, - "name": "id", - "related": "createUser,enableUser,getUser", - "required": true, - "type": "uuid" + "type": "map" } ], + "related": "", "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": "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" - }, - {} - ], - "since": "4.11" + "description": "the ID of the network device", + "name": "id", + "type": "string" + } + ] }, { - "description": "List routers.", - "isasync": false, - "name": "listRouters", + "description": "Restarts a VPC", + "isasync": true, + "name": "restartVPC", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the id of the VPC", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "id", + "related": "createVPC,listVPCs,updateVPC", + "required": true, + "type": "uuid" }, { - "description": "list virtual router elements by version", + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", "length": 255, - "name": "version", + "name": "livepatch", "required": false, - "type": "string" + "since": "4.17.0", + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "Turn a single VPC into a redundant one.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "makeredundant", "required": false, - "type": "uuid" + "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.", + "description": "If cleanup old network elements", "length": 255, - "name": "listall", + "name": "cleanup", "required": false, "type": "boolean" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "if true is passed for this parameter, list only VPC routers", + "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": "adds a baremetal dhcp server", + "isasync": true, + "name": "addBaremetalDhcp", + "params": [ + { + "description": "URL of the external dhcp appliance.", "length": 255, - "name": "forvpc", - "required": false, - "type": "boolean" + "name": "url", + "required": true, + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Credentials to reach external dhcp device", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "name": "username", + "required": true, + "type": "string" }, { - "description": "if this parameter is passed, list only routers by health check results", + "description": "Type of dhcp device", "length": 255, - "name": "healthchecksfailed", - "required": false, - "since": "4.16", - "type": "boolean" + "name": "dhcpservertype", + "required": true, + "type": "string" }, { - "description": "the name of the router", + "description": "Credentials to reach external dhcp device", "length": 255, - "name": "name", - "required": false, + "name": "password", + "required": true, "type": "string" }, { - "description": "List networks by VPC", + "description": "the Physical Network ID", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", - "required": false, + "name": "physicalnetworkid", + "related": "", + "required": true, "type": "uuid" + } + ], + "related": "listBaremetalDhcp", + "response": [ + { + "description": "url", + "name": "url", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "the state of the router", - "length": 255, - "name": "state", - "required": false, + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the cluster ID of the router", + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "name of the provider", + "name": "dhcpservertype", + "type": "string" + } + ] + }, + { + "description": "delete Tungsten-Fabric application policy set", + "isasync": true, + "name": "deleteTungstenFabricApplicationPolicySet", + "params": [ + { + "description": "the ID of zone", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "the Pod ID of the router", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "name": "applicationpolicysetuuid", + "required": true, + "type": "string" + } + ], + "response": [ + {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the host ID of the router", + "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": "Copies a snapshot from one zone to another.", + "isasync": true, + "name": "copySnapshot", + "params": [ + { + "description": "The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used.", "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "name": "sourcezoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "the ID of the disk router", + "description": "the ID of the snapshot.", "length": 255, "name": "id", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, + "related": "copySnapshot,listSnapshots", + "required": true, "type": "uuid" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", + "description": "The ID of the zone the snapshot is being copied to.", "length": 255, - "name": "fetchhealthcheckresults", + "name": "destzoneid", + "related": "listZones", "required": false, - "since": "4.14", - "type": "boolean" + "type": "uuid" }, { - "description": "list by network id", + "description": "A comma-separated list of IDs of the zones that the snapshot needs to be copied to. Specify this list if the snapshot 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": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "destzoneids", + "related": "listZones", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "", + "description": "A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present. Currently supported for StorPool only", "length": 255, - "name": "page", + "name": "storageids", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "list" }, { - "description": "the Zone ID of the router", + "description": "This parameter enables the option the snapshot to be copied to supported primary storage", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "usestoragereplication", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "boolean" } ], - "related": "destroyRouter", + "related": "listSnapshots", "response": [ - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", + "type": "long" + }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", "type": "boolean" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, - {}, { - "description": "the template ID for the router", - "name": "templateid", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - } - ], - "type": "list" + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" + }, + { + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" + }, + { + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { @@ -110125,235 +141076,177 @@ var preCache = `{ "type": "boolean" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, + {}, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, + {}, { - "description": "the domain associated with the router", - "name": "domain", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Adds Traffic Monitor Host for Direct Network Usage", + "isasync": false, + "name": "addTrafficMonitor", + "params": [ { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "URL of the traffic monitor Host", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "Zone in which to add the external firewall appliance.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "Traffic going into the listed zones will be metered", + "length": 255, + "name": "includezones", + "required": false, + "type": "string" + }, + { + "description": "Traffic going into the listed zones will not be metered", + "length": 255, + "name": "excludezones", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { @@ -110362,151 +141255,273 @@ var preCache = `{ "type": "integer" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, + {}, + {}, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the ID of the external firewall", + "name": "id", "type": "string" + } + ] + }, + { + "description": "Lists user accounts", + "isasync": false, + "name": "listUsers", + "params": [ + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "List users by state of the user account.", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the account associated with the router", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List user by the username", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, + { + "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", + "length": 255, + "name": "accounttype", + "required": false, + "type": "integer" + }, + { + "description": "List user by ID.", + "length": 255, + "name": "id", + "related": "disableUser,getUser,listUsers", + "required": false, + "type": "uuid" + }, + { + "description": "List users by their authentication source. Valid values are: native, ldap, saml2 and saml2disabled.", + "length": 255, + "name": "usersource", + "required": false, + "since": "4.21.0.0", + "type": "string" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "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": "flag to display the resource icon for users", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" + }, + { + "description": "List users by the Api key access value", + "length": 255, + "name": "apikeyaccess", + "required": false, + "since": "4.20.1.0", + "type": "string" + } + ], + "related": "disableUser,getUser", + "response": [ + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - } - ] - }, - { - "description": "Releases host reservation.", - "isasync": true, - "name": "releaseHostReservation", - "params": [ + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, { - "description": "the host ID", - "length": 255, - "name": "id", - "related": "reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the account type of the user", + "name": "accounttype", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the user state", + "name": "state", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, {}, @@ -110514,160 +141529,128 @@ var preCache = `{ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { - "description": "list Tungsten-Fabric vm", + "description": "Updates a VLAN IP range.", "isasync": false, - "name": "listTungstenFabricVm", + "name": "updateVlanIpRange", "params": [ { - "description": "", + "description": "the gateway of the IPv6 network", "length": 255, - "name": "page", + "name": "ip6gateway", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "pagesize", + "name": "startipv6", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "keyword", + "name": "ip6cidr", "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "the beginning IP address in the VLAN IP range", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "startip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric vm", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "vmuuid", + "name": "netmask", "required": false, "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "Tungsten-Fabric nic uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {}, - { - "description": "Tungsten-Fabric vm name", - "name": "name", - "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - } - ] - }, - { - "description": "Create site to site vpn connection", - "isasync": true, - "name": "createVpnConnection", - "params": [ - { - "description": "connection is passive or not", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "passive", + "name": "endipv6", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "id of the vpn gateway", + "description": "the UUID of the VLAN IP range", "length": 255, - "name": "s2svpngatewayid", - "related": "createVpnGateway", + "name": "id", + "related": "updateVlanIpRange", "required": true, "type": "uuid" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "the gateway of the VLAN IP range", "length": 255, - "name": "fordisplay", + "name": "gateway", + "required": false, + "type": "string" + }, + { + "description": "true if IP range is set to system vms, false if not", + "length": 255, + "name": "forsystemvms", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "id of the customer gateway", + "description": "the ending IP address in the VLAN IP range", "length": 255, - "name": "s2scustomergatewayid", - "related": "createVpnCustomerGateway", - "required": true, - "type": "uuid" + "name": "endip", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "the network id of vlan range", + "name": "networkid", + "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "the cidr of the VLAN IP range", + "name": "cidr", + "type": "string" }, + {}, + {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the domain ID of the VLAN IP range", + "name": "domainid", + "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "indicates to which provider the IP range is dedicated to", + "name": "provider", + "type": "string" + }, + { + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { @@ -110676,224 +141659,301 @@ var preCache = `{ "type": "integer" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, - {}, - { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the end ip of the VLAN IP range", + "name": "endip", + "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", + "type": "string" }, { - "description": "the project id", + "description": "the project id of the vlan range", "name": "projectid", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the project name of the vlan range", + "name": "project", + "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the owner", - "name": "account", - "type": "string" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, - {} - ] + { + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" + } + ], + "since": "4.16.0" }, { - "description": "lists network that are using a brocade vcs switch", + "description": "Lists resource limits.", "isasync": false, - "name": "listBrocadeVcsDeviceNetworks", + "name": "listResourceLimits", "params": [ { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "brocade vcs switch ID", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "vcsdeviceid", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "length": 255, + "name": "resourcetypename", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "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" + }, + { + "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": "Lists resource limits by ID.", + "length": 255, + "name": "id", + "required": false, + "type": "long" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", "related": "", - "required": true, + "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "Type of resource. 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 an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", "length": 255, - "name": "keyword", + "name": "resourcetype", "required": false, + "type": "integer" + }, + { + "description": "Tag for the resource type", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "related": "", "response": [ { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", + "type": "long" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the domain name of the resource limit", + "name": "domain", + "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 account of the resource limit", + "name": "account", + "type": "string" }, + {}, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "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 network domain", - "name": "networkdomain", + "description": "the project id of the resource limit", + "name": "projectid", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "The tag for the resource limit", + "name": "tag", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "path of the domain to which the resource limit belongs", + "name": "domainpath", + "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the project name of the resource limit", + "name": "project", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the domain ID of the resource limit", + "name": "domainid", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "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": "Disables a user account", + "isasync": true, + "name": "disableUser", + "params": [ { - "description": "the network's netmask", - "name": "netmask", + "description": "Disables user by user ID.", + "length": 255, + "name": "id", + "related": "disableUser,getUser", + "required": true, + "type": "uuid" + } + ], + "related": "getUser", + "response": [ + { + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -110902,315 +141962,354 @@ var preCache = `{ "type": "resourceiconresponse" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the date this network was created", + "description": "the date and time the user account was created", "name": "created", "type": "date" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, + {}, + {}, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user name", + "name": "username", "type": "string" + } + ] + }, + { + "description": "Lists all available ISO files.", + "isasync": false, + "name": "listIsos", + "params": [ + { + "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": "the name of the network", - "name": "name", - "type": "string" + "description": "true if the ISO is publicly available to all users, false otherwise.", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "show removed ISOs as well", + "length": 255, + "name": "showremoved", + "required": false, "type": "boolean" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" + "description": "the ID of the OS category for the ISO", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories", + "required": false, + "since": "4.21.0", + "type": "uuid" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "ID of the storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "since": "4.19", + "type": "uuid" + }, + { + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "ID of the image or image cache store", + "length": 255, + "name": "imagestoreid", + "related": "listSwifts", + "required": false, + "since": "4.19", + "type": "uuid" + }, + { + "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "length": 255, + "name": "isofilter", + "required": false, "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "list all ISOs by name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "true if the ISO is bootable, false otherwise", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "If set to true, list only unique isos across zones", + "length": 255, + "name": "showunique", + "required": false, + "since": "4.13.2", + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "list ISO by ID", + "length": 255, + "name": "id", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "flag to display the resource image for the isos", + "length": 255, + "name": "showicon", + "required": false, "type": "boolean" }, - {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "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": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "list ISOs that are ready to be deployed", + "length": 255, + "name": "isready", + "required": false, "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, - {}, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -111224,125 +142323,289 @@ var preCache = `{ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the project name of the address", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the project name of the template", "name": "project", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "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", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "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 name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - } - ] - }, - { - "description": "Deletes a Physical Network.", - "isasync": true, - "name": "deletePhysicalNetwork", - "params": [ + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { - "description": "the ID of the Physical network", - "length": 255, - "name": "id", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "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": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + {}, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, {}, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "The ID of extension linked to this template", + "name": "extensionid", + "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", + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { @@ -111350,154 +142613,132 @@ var preCache = `{ "name": "jobid", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "add Tungsten-Fabric policy rule", - "isasync": true, - "name": "addTungstenFabricPolicyRule", + "description": "Lists autoscale policies.", + "isasync": false, + "name": "listAutoScalePolicies", "params": [ { - "description": "Tungsten-Fabric policy rule protocol", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, - { - "description": "Tungsten-Fabric policy rule source network", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", "length": 255, - "name": "srcnetwork", - "required": true, + "name": "action", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination end port", + "description": "the ID of the autoscale vm group", "length": 255, - "name": "destendport", - "required": true, - "type": "integer" + "name": "vmgroupid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "Tungsten-Fabric policy rule source start port", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "srcstartport", - "required": true, - "type": "integer" + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "Tungsten-Fabric policy rule source end port", + "description": "", "length": 255, - "name": "srcendport", - "required": true, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the name of the autoscale policy", "length": 255, - "name": "policyuuid", - "required": true, + "name": "name", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "Tungsten-Fabric policy rule source ip prefix length", - "length": 255, - "name": "srcipprefixlen", - "required": true, - "type": "integer" - }, - { - "description": "Tungsten-Fabric policy rule destination ip prefix", + "description": "the ID of the autoscale policy", "length": 255, - "name": "destipprefix", - "required": true, - "type": "string" + "name": "id", + "related": "listAutoScalePolicies", + "required": false, + "type": "uuid" }, { - "description": "Tungsten-Fabric policy rule source ip prefix", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "srcipprefix", - "required": true, - "type": "string" + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "Tungsten-Fabric policy rule action", + "description": "the ID of the condition of the policy", "length": 255, - "name": "action", - "required": true, - "type": "string" + "name": "conditionid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix length", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "destipprefixlen", - "required": true, - "type": "integer" + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the ID of zone", + "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": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "Tungsten-Fabric policy rule destination start port", + "description": "List by keyword", "length": 255, - "name": "deststartport", - "required": true, - "type": "integer" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination network", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "destnetwork", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric policy rule direction", + "description": "", "length": 255, - "name": "direction", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", - "type": "string" + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, - {}, { - "description": "Tungsten-Fabric policy name", - "name": "direction", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", - "type": "int" - }, - {}, - { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", - "type": "int" + "description": "the autoscale policy ID", + "name": "id", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -111505,437 +142746,767 @@ var preCache = `{ "type": "integer" }, { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", - "type": "string" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Tungsten-Fabric rule uuid", - "name": "uuid", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, + {}, { - "description": "Tungsten-Fabric policy action", - "name": "action", + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix", - "name": "srcipprefix", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", - "type": "int" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" } ] }, { - "description": "Dedicates a host.", + "description": "Dedicates an existing IPv4 subnet for a zone to an account or a domain.", "isasync": true, - "name": "dedicateHost", + "name": "dedicateIpv4SubnetForZone", "params": [ { - "description": "the ID of the containing domain", + "description": "account who will own the IPv4 subnet", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "domain ID of the account owning the IPv4 subnet", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": true, + "related": "listDomains", + "required": false, "type": "uuid" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "description": "project who will own the IPv4 subnet", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the host to update", + "description": "Id of the guest network IPv4 subnet", "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "name": "id", + "related": "dedicateIpv4SubnetForZone", "required": true, "type": "uuid" } ], - "related": "listDedicatedHosts", + "related": "", "response": [ { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, + {}, { - "description": "the Account ID of the host", - "name": "accountid", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the domain ID of the host", - "name": "domainid", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the IPv4 subnet", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, {}, { - "description": "the name of the host", - "name": "hostname", + "description": "id of the guest IPv4 subnet", + "name": "id", + "type": "string" + }, + { + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + { + "description": "the project name of the IPv4 subnet", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "adds baremetal rack configuration text", + "isasync": true, + "name": "addBaremetalRct", + "params": [ + { + "description": "http url to baremetal RCT configuration", + "length": 255, + "name": "baremetalrcturl", + "required": true, + "type": "object" + } + ], + "related": "", + "response": [ + { + "description": "id of rct", + "name": "id", + "type": "string" + }, + { + "description": "url", + "name": "url", "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": "Removes vpn user", - "isasync": true, - "name": "removeVpnUser", + "description": "List Shared FileSystems", + "isasync": false, + "name": "listSharedFileSystems", "params": [ { - "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" + }, + { + "description": "the disk offering of the shared filesystem", + "length": 255, + "name": "diskofferingid", + "related": "", "required": false, "type": "uuid" }, { - "description": "username for the vpn user", + "description": "", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "remove vpn user from the project", + "description": "the ID of the shared filesystem", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "id", + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", "required": false, "type": "uuid" }, { - "description": "an optional account for the vpn user. Must be used with domainId.", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" - } - ], - "response": [ - {}, + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the shared filesystem", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Adds the GloboDNS external host", - "isasync": true, - "name": "addGloboDnsHost", - "params": [ + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, { - "description": "Username for GloboDNS", + "description": "the service offering of the shared filesystem", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" }, { - "description": "Password for GloboDNS", + "description": "the ID of the availability zone", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the Physical Network ID", + "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": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, "type": "uuid" }, { - "description": "GloboDNS url", + "description": "List by keyword", "length": 255, - "name": "url", - "required": true, + "name": "keyword", + "required": false, "type": "string" + }, + { + "description": "the ID of the network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" } ], + "related": "changeSharedFileSystemDiskOffering", "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the shared filesystem", + "name": "name", + "type": "string" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" + }, + {}, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} - ], - "since": "4.5.0" - }, - { - "description": "List public IP addresses in quarantine.", - "isasync": false, - "name": "listQuarantinedIps", - "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "Show IPs removed from quarantine.", - "length": 255, - "name": "showremoved", - "required": false, - "type": "boolean" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" }, { - "description": "Show IPs that are no longer in quarantine.", - "length": 255, - "name": "showinactive", - "required": false, - "type": "boolean" + "description": "the list of nics associated with the shared filesystem", + "name": "nic", + "response": [ + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + } + ], + "type": "list" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "updateQuarantinedIp", - "response": [ + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { - "description": "ID of the quarantine process.", + "description": "ID of the shared filesystem", "name": "id", "type": "string" }, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "When the quarantine was removed.", - "name": "removed", - "type": "date" + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" }, { - "description": "The public IP address in quarantine.", - "name": "ipaddress", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "End date for the quarantine.", - "name": "enddate", - "type": "date" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, - {}, { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, - {}, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the filesystem format", + "name": "filesystem", "type": "string" - } - ], - "since": "4.19" - }, - { - "description": "Logs out the user", - "isasync": false, - "name": "logout", - "params": [], - "related": "", - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, - {}, { - "description": "Response description", - "name": "description", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Deletes a load balancer health check policy.", - "isasync": true, - "name": "deleteLBHealthCheckPolicy", - "params": [ - { - "description": "the ID of the load balancer health check policy", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, - {}, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "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": "id of the resource", + "name": "resourceid", + "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" + } + ], + "type": "set" + }, {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + { + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" } ], - "since": "4.2.0" + "since": "4.20.0" }, { - "description": "Imports a role based on provided map of rule permissions", + "description": "Updates a role", "isasync": false, - "name": "importRole", + "name": "updateRole", "params": [ { "description": "The description of the role", @@ -111945,162 +143516,152 @@ var preCache = `{ "type": "string" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", "length": 255, - "name": "type", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Creates a role with this unique name", + "description": "creates a role with this unique name", "length": 255, "name": "name", - "required": true, + "required": false, "type": "string" }, { - "description": "Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false.", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "forced", + "name": "type", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing", + "description": "The description of the role", "length": 255, - "name": "rules", - "required": true, - "type": "map" + "name": "description", + "required": false, + "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "description": "ID of the role", "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "name": "id", + "related": "listRoles,updateRole", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "listRoles", "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the state of the role", + "name": "state", + "type": "string" + }, + { + "description": "the name of the role", + "name": "name", + "type": "string" + }, { "description": "true if role is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" + "description": "the description of the role", + "name": "description", + "type": "string" }, {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the type of the role", "name": "type", "type": "string" }, { - "description": "the ID of the role", - "name": "id", - "type": "string" + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, { - "description": "the name of the role", - "name": "name", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "the description of the role", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], - "since": "4.15.0" + "since": "4.9.0" }, { - "description": "Disables HA for a host", - "isasync": true, - "name": "disableHAForHost", + "description": "Lists remote access vpns", + "isasync": false, + "name": "listRemoteAccessVpns", "params": [ { - "description": "ID of the host", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", - "required": true, + "name": "domainid", + "related": "listDomains", + "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" - }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - {}, - {}, - { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "Lists remote access vpn rule with the specified ID", + "length": 255, + "name": "id", + "related": "listRemoteAccessVpns", + "required": false, + "since": "4.3", + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "operation status", - "name": "status", + "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" - } - ], - "since": "4.11" - }, - { - "description": "List Swift.", - "isasync": false, - "name": "listSwifts", - "params": [ + }, { - "description": "", + "description": "list remote access VPNs for certain network", "length": 255, - "name": "page", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "integer" + "since": "4.3", + "type": "uuid" }, { - "description": "the id of the swift", + "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": "id", + "name": "listall", "required": false, - "type": "long" + "type": "boolean" }, { "description": "List by keyword", @@ -112109,162 +143670,179 @@ var preCache = `{ "required": false, "type": "string" }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "", "length": 255, "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "public ip address id of the vpn server", + "length": 255, + "name": "publicipid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" } ], - "related": "addImageStoreS3,listImageStores", + "related": "", "response": [ { - "description": "the provider name of the image store", - "name": "providername", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the public ip address of the vpn server", + "name": "publicip", + "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the url of the image store", - "name": "url", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the domain name of the account of the remote access vpn", + "name": "domain", + "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", + "type": "string" }, - {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the account of the remote access vpn", + "name": "account", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the id of the remote access vpn", + "name": "id", + "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Enables out-of-band management for a host", - "isasync": true, - "name": "enableOutOfBandManagementForHost", + "description": "Deletes a Webhook", + "isasync": false, + "name": "deleteWebhook", "params": [ { - "description": "the ID of the host", + "description": "The ID of the Webhook", "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "name": "id", + "related": "createWebhook", "required": true, "type": "uuid" } ], - "related": "disableOutOfBandManagementForCluster", "response": [ { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, - { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, + {}, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.20.0" + }, + { + "description": "Deletes a network ACL", + "isasync": true, + "name": "deleteNetworkACLList", + "params": [ { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" - }, + "description": "the ID of the network ACL", + "length": 255, + "name": "id", + "related": "createNetworkACLList", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { @@ -112273,23 +143851,27 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } - ], - "since": "4.9.0" + ] }, { - "description": "Deletes a service offering.", - "isasync": false, - "name": "deleteServiceOffering", + "description": "Removes secondary IP from the NIC.", + "isasync": true, + "name": "removeIpFromNic", "params": [ { - "description": "the ID of the service offering", + "description": "the ID of the secondary ip address to nic", "length": 255, "name": "id", - "related": "updateServiceOffering,listServiceOfferings", + "related": "", "required": true, "type": "uuid" } @@ -112301,149 +143883,137 @@ var preCache = `{ "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", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ] }, { - "description": "Lists supported Kubernetes version", - "isasync": false, - "name": "listKubernetesSupportedVersions", + "description": "Creates a system virtual-machine that implements network services", + "isasync": true, + "name": "createServiceInstance", "params": [ { - "description": "the minimum semantic version for the Kubernetes supported version to be listed", + "description": "The name of the service instance", "length": 255, - "name": "minimumsemanticversion", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "List by keyword", + "description": "The right (outside) network ID for the service instance", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "rightnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "The service offering ID that defines the resources consumed by the service appliance", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "Project ID for the service instance", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the minimum Kubernetes supported version", + "description": "The left (inside) network for service instance", "length": 255, - "name": "minimumkubernetesversionid", - "related": "listKubernetesSupportedVersions", - "required": false, + "name": "leftnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": true, "type": "uuid" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "Availability zone for the service instance", "length": 255, "name": "zoneid", - "related": "createZone,listZones", - "required": false, + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "the ID of the Kubernetes supported version", + "description": "An optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "id", - "related": "listKubernetesSupportedVersions", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" + }, + { + "description": "The template ID that specifies the image for the service appliance", + "length": 255, + "name": "templateid", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", - "type": "string" - }, - { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "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 binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" - }, - { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, - { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" - }, {}, { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the id of the Kubernetes supported version", + "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -112451,275 +144021,241 @@ var preCache = `{ "type": "integer" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "path of the Domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "the project name of the vm", + "name": "project", "type": "string" }, {}, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" } ] }, { - "description": "Adds a Nicira NVP device", + "description": "Starts a system virtual machine.", "isasync": true, - "name": "addNiciraNvpDevice", + "name": "startSystemVm", "params": [ { - "description": "Hostname of ip address of the Nicira NVP Controller.", + "description": "The ID of the system virtual machine", "length": 255, - "name": "hostname", + "name": "id", + "related": "startSystemVm", "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "Credentials to access the Nicira Controller API", - "length": 255, - "name": "password", - "required": true, + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "Credentials to access the Nicira Controller API", - "length": 255, - "name": "username", - "required": true, + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "The Transportzone UUID configured on the Nicira Controller", - "length": 255, - "name": "transportzoneuuid", - "required": true, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The L3 Gateway Service UUID configured on the Nicira Controller", - "length": 255, - "name": "l3gatewayserviceuuid", - "required": false, + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "The L2 Gateway Service UUID configured on the Nicira Controller", - "length": 255, - "name": "l2gatewayserviceuuid", - "required": false, - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, - {}, { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the name of the system VM", + "name": "name", + "type": "string" + }, + { + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, - {}, { - "description": "device name", - "name": "niciradevicename", + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" - } - ] - }, - { - "description": "Lists network serviceproviders for a given physical network.", - "isasync": false, - "name": "listNetworkServiceProviders", - "params": [ + }, { - "description": "list providers by name", - "length": 255, - "name": "name", - "required": false, + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "description": "list providers by state", - "length": 255, - "name": "state", - "required": false, + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" + }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "the provider name", - "name": "name", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, + {}, { - "description": "state of the network provider", - "name": "state", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "CPU arch of the system VM", + "name": "arch", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "delete Tungsten-Fabric tag type", - "isasync": true, - "name": "deleteTungstenFabricTagType", - "params": [ + }, { - "description": "the ID of Tungsten-Fabric tag type", - "length": 255, - "name": "tagtypeuuid", - "required": true, + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -112728,275 +144264,388 @@ var preCache = `{ ] }, { - "description": "Lists infrastructure", + "description": "Registers an existing VNF template into the CloudStack cloud. ", "isasync": false, - "name": "listInfrastructure", - "params": [], - "related": "", - "response": [ + "name": "registerVnfTemplate", + "params": [ { - "description": "Number of images stores", - "name": "imagestores", - "type": "integer" + "description": "true if the template or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" }, { - "description": "Number of routers", - "name": "routers", - "type": "integer" + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "length": 255, + "name": "deployasis", + "required": false, + "since": "4.15.1", + "type": "boolean" }, { - "description": "Number of management servers", - "name": "managementservers", - "type": "integer" + "description": "true if the template supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" }, { - "description": "Number of Alerts", - "name": "alerts", - "type": "integer" + "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "length": 255, + "name": "vnfdetails", + "required": false, + "type": "map" }, { - "description": "Number of zones", - "name": "zones", - "type": "integer" + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "length": 255, + "name": "format", + "required": true, + "type": "string" }, { - "description": "Number of pods", - "name": "pods", - "type": "integer" + "description": "if true, the templates would be available for deploying CKS clusters", + "length": 255, + "name": "forcks", + "required": false, + "since": "4.21.0", + "type": "boolean" }, { - "description": "Number of systemvms", - "name": "systemvms", - "type": "integer" + "description": "the name of the template", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "Number of hypervisor hosts", - "name": "hosts", - "type": "integer" + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" }, - {}, { - "description": "Number of object stores", - "name": "objectstores", - "type": "integer" + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the template is available to all accounts; default is true", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" }, { - "description": "Number of internal LBs", - "name": "ilbvms", - "type": "integer" + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "type": "string" }, - {}, { - "description": "Number of clusters", - "name": "clusters", - "type": "integer" + "description": "ID of the extension", + "length": 255, + "name": "extensionid", + "related": "listExtensions", + "required": false, + "since": "4.21.0", + "type": "uuid" }, { - "description": "Number of cpu sockets", - "name": "cpusockets", - "type": "integer" + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "length": 255, + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" + }, + { + "description": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { - "description": "Number of storage pools", - "name": "storagepools", - "type": "integer" - } - ], - "since": "4.9.3" - }, - { - "description": "Lists usage records for accounts", - "isasync": false, - "name": "listUsageRecords", - "params": [ + "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", + "length": 255, + "name": "vnfnics", + "required": false, + "type": "map" + }, { - "description": "List usage records for specified project", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "length": 255, + "name": "templatetype", + "required": false, + "since": "4.19.0", + "type": "string" + }, + { + "description": "Register template for the project", "length": 255, "name": "projectid", - "related": "activateProject,suspendProject", + "related": "", "required": false, "type": "uuid" }, { - "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "usageid", + "name": "isfeatured", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "oldformat", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "End date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00).", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "enddate", - "required": true, - "type": "date" + "name": "bits", + "required": false, + "type": "integer" }, { - "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "isrecursive", + "name": "isrouting", "required": false, - "since": "4.15", "type": "boolean" }, { - "description": "List usage records for the specified account", + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", + "name": "directdownload", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", "length": 255, - "name": "pagesize", + "name": "zoneids", + "related": "listZones", "required": false, - "type": "integer" + "type": "list" }, { - "description": "", - "length": 255, - "name": "page", + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List usage records for the specified domain.", + "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "ostypeid", + "related": "", "required": false, "type": "uuid" }, { - "description": "Start date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00).", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "startdate", - "required": true, - "type": "date" + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" }, { - "description": "List usage records for the specified user.", + "description": "true if this template requires HVM", "length": 255, - "name": "account", + "name": "requireshvm", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Flag to enable display of Tags for a resource", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "includetags", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List usage records for the specified usage type", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "type", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "keyword", + "name": "checksum", + "required": false, + "type": "string" + }, + { + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", "required": false, + "since": "4.20", "type": "string" } ], - "related": "", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "id of the network", - "name": "networkid", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", - "name": "issystem", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the domain ID", - "name": "domainid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "speed of each cpu of resource", - "name": "cpuspeed", - "type": "long" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "memory allocated for the resource", - "name": "memory", - "type": "long" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "template ID", - "name": "templateid", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "virtual machine guest os category ID", - "name": "oscategoryid", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "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": "raw usage in hours", - "name": "rawusage", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "id of the vpc", - "name": "vpcid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "usage in hours", - "name": "usage", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "virtual size of resource", - "name": "virtualsize", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "True if the resource is default", - "name": "isdefault", + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "end date of the usage record", - "name": "enddate", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "virtual machine os category name", - "name": "oscategoryname", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "id of the resource", - "name": "usageid", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, {}, @@ -113005,33 +144654,38 @@ var preCache = `{ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -113040,157 +144694,163 @@ var preCache = `{ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the user account name", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "the account name to which the template belongs", "name": "account", "type": "string" }, { - "description": "resource or virtual machine name", - "name": "name", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the template ID", + "name": "id", + "type": "string" }, { - "description": "virtual machine os type ID", - "name": "ostypeid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "True if the IPAddress is source NAT", - "name": "issourcenat", + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "number of cpu of resource", - "name": "cpunumber", - "type": "long" + "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": "offering ID", - "name": "offeringid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain the resource is associated with", + "description": "the name of the domain to which the template belongs", "name": "domain", "type": "string" }, { - "description": "the project name of the resource", - "name": "project", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, - {}, { - "description": "the user account Id", - "name": "accountid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "start date of the usage record", - "name": "startdate", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "description of the usage record", - "name": "description", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "virtual machine os display name", - "name": "osdisplayname", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "resource size", - "name": "size", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project id of the resource", - "name": "projectid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "virtual machine ID", - "name": "virtualmachineid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "resource type", - "name": "type", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "usage type ID", - "name": "usagetype", - "type": "integer" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the zone ID", - "name": "zoneid", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Deletes an Object Storage Pool", - "isasync": false, - "name": "deleteObjectStoragePool", - "params": [ + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, { - "description": "The Object Storage ID.", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, - {}, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the size of the template", + "name": "size", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", @@ -113198,77 +144858,89 @@ var preCache = `{ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" } ], "since": "4.19.0" }, { - "description": "Delete Netscaler Control Center", + "description": "Lists VM stats", "isasync": false, - "name": "deleteNetscalerControlCenter", + "name": "listVirtualMachinesUsageHistory", "params": [ { - "description": "Netscaler Control Center ID", + "description": "the IDs of the virtual machines, mutually exclusive with id.", "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "string" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "name": "ids", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "list" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the virtual machine.", + "length": 255, + "name": "id", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "uuid" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - } - ] - }, - { - "description": "Deletes a detached disk volume.", - "isasync": false, - "name": "deleteVolume", - "params": [ + }, { - "description": "The ID of the disk volume", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "id", - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "name": "startdate", + "required": false, + "type": "date" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], + "related": "listSystemVmsUsageHistory", "response": [ {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the list of VM stats", + "name": "stats", + "type": "list" }, {}, { @@ -113276,391 +144948,301 @@ var preCache = `{ "name": "jobstatus", "type": "integer" }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } - ] + ], + "since": "4.17" }, { - "description": "Recovers a Destroy volume.", - "isasync": false, - "name": "recoverVolume", + "description": "Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host.", + "isasync": true, + "name": "declareHostAsDegraded", "params": [ { - "description": "The ID of the volume", + "description": "host ID", "length": 255, "name": "id", - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "declareHostAsDegraded,reconnectHost", "required": true, "type": "uuid" } ], - "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "reconnectHost", "response": [ { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "name of the availability zone", - "name": "zonename", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "type": "boolean" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, - {}, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "the status of the volume", - "name": "status", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "size of the disk volume", - "name": "size", - "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": "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 path of the volume", - "name": "path", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, + {}, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, + {}, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "Used GPUs on the Host", + "name": "gpuused", "type": "long" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -113668,2204 +145250,2187 @@ var preCache = `{ "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "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", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, - {} - ], - "since": "4.14.0" - }, - { - "description": "remove Tungsten-Fabric network gateway from logical router", - "isasync": true, - "name": "removeTungstenFabricNetworkGatewayFromLogicalRouter", - "params": [ { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, + {}, { - "description": "Tungsten-Fabric network uuid", - "length": 255, - "name": "networkuuid", - "required": true, - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "Tungsten-Fabric logical router uuid", - "length": 255, - "name": "logicalrouteruuid", - "required": true, + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "Tungsten-Fabric logical router name", - "name": "name", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - } - ] - }, - { - "description": "Updates an existing secondary storage selector.", - "isasync": false, - "name": "updateSecondaryStorageSelector", - "params": [ - { - "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; } would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", - "length": 65535, - "name": "heuristicrule", - "required": true, + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "The unique identifier of the secondary storage selector.", - "length": 255, - "name": "id", - "related": "updateSecondaryStorageSelector,removeSecondaryStorageSelector", - "required": true, - "type": "uuid" - } - ], - "related": "removeSecondaryStorageSelector", - "response": [ - { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, - {}, { - "description": "ID of the heuristic.", - "name": "id", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, - {}, { - "description": "Name of the heuristic.", - "name": "name", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "Description of the heuristic.", - "name": "description", - "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 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": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" } ], - "since": "4.19.0" + "since": "4.16.0.0" }, { - "description": "Enables a user account", - "isasync": false, - "name": "enableUser", + "description": "Creates a Kubernetes cluster", + "isasync": true, + "name": "createKubernetesCluster", "params": [ { - "description": "Enables user by user ID.", + "description": "name for the Kubernetes cluster", "length": 255, - "name": "id", - "related": "createUser,enableUser,getUser", + "name": "name", "required": true, - "type": "uuid" - } - ], - "related": "createUser,getUser", - "response": [ - { - "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 account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the user name", - "name": "username", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "(Optional) Node Type to Template ID mapping. If provided, it overrides the default template: System VM template", + "length": 255, + "name": "nodetemplates", + "required": false, + "since": "4.21.0", + "type": "map" }, { - "description": "the user state", - "name": "state", + "description": "the hypervisor on which the CKS cluster is to be deployed. This is required if the zone in which the CKS cluster is being deployed has clusters with different hypervisor types.", + "length": 255, + "name": "hypervisor", + "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "availability zone in which Kubernetes cluster to be launched", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", + "length": 255, + "name": "externalloadbalanceripaddress", + "required": false, "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "password for the docker image private registry", + "length": 255, + "name": "dockerregistrypassword", + "required": false, "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "Network in which Kubernetes cluster is to be launched", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "name of the ssh key pair used to login to the virtual machines", + "length": 255, + "name": "keypair", + "required": false, "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "Deploy cluster for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the user ID", - "name": "id", + "description": "user name for the docker image private registry", + "length": 255, + "name": "dockerregistryusername", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the secret key of the user", - "name": "secretkey", + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the ID of the service offering for the virtual machines in the cluster.", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" }, { - "description": "the type of the role", - "name": "roletype", + "description": "type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.", + "length": 255, + "name": "clustertype", + "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "number of Kubernetes cluster control nodes, default is 1", + "length": 255, + "name": "controlnodes", + "required": false, + "type": "long" }, - {} - ] - }, - { - "description": "Lists zone metrics", - "isasync": false, - "name": "listZonesMetrics", - "params": [ { - "description": "the network type of the zone that the virtual machine belongs to", + "description": "number of Kubernetes cluster worker nodes", "length": 255, - "name": "networktype", + "name": "size", "required": false, - "type": "string" + "type": "long" }, { - "description": "the name of the zone", + "description": "root disk size in GB for each node", "length": 255, - "name": "name", + "name": "noderootdisksize", "required": false, - "type": "string" + "type": "long" }, { - "description": "flag to display the resource image for the zones", + "description": "used to specify the parameters values for the variables in userdata. Example: cniconfigdetails[0].key=accesskey&cniconfigdetails[0].value=s389ddssaa&cniconfigdetails[1].key=secretkey&cniconfigdetails[1].value=8dshfsss", "length": 255, - "name": "showicon", + "name": "cniconfigdetails", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "map" }, { - "description": "", + "description": "Kubernetes version with which cluster to be launched", "length": 255, - "name": "page", + "name": "kubernetesversionid", + "related": "listKubernetesSupportedVersions", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", + "description": "URL for the docker image private registry", "length": 255, - "name": "available", + "name": "dockerregistryurl", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the domain associated with the zone", + "description": "description for the Kubernetes cluster", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the IDs of the zones, mutually exclusive with id", + "description": "(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter", "length": 255, - "name": "ids", - "related": "createZone,listZones", + "name": "nodeofferings", "required": false, - "since": "4.19.0", - "type": "list" + "since": "4.21.0", + "type": "map" }, { - "description": "", + "description": "the AS Number of the network", "length": 255, - "name": "pagesize", + "name": "asnumber", "required": false, - "type": "integer" + "type": "long" }, { - "description": "the ID of the zone", + "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", "length": 255, - "name": "id", - "related": "createZone,listZones", + "name": "masternodes", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "List by keyword", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. Hosts dedicated to the specified domain will be used for deploying the cluster", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "flag to display the capacity of the zones", + "description": "the ID of the Userdata", "length": 255, - "name": "showcapacities", + "name": "cniconfigurationid", + "related": "", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "uuid" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "(Optional) Number of Kubernetes cluster etcd nodes, default is 0.In case the number is greater than 0, etcd nodes are separate from master nodes and are provisioned accordingly", "length": 255, - "name": "tags", + "name": "etcdnodes", "required": false, - "since": "4.3", - "type": "map" + "since": "4.21.0", + "type": "long" } ], - "related": "", + "related": "startKubernetesCluster", "response": [ { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" - }, - { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - { - "description": "Zone name", - "name": "name", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "the display text of the zone", - "name": "displaytext", - "type": "string" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, {}, { - "description": "Zone id", - "name": "id", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", + "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", "type": "boolean" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "healthy / total clusters in the zone", - "name": "clusters", - "type": "string" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" }, { - "description": "state of the cluster", - "name": "state", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "Zone Token", - "name": "zonetoken", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", "type": "map" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the capacity of the Zone", - "name": "capacity", - "response": [ - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - } - ], - "type": "list" + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "type": "string" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the state of the Kubernetes cluster", + "name": "state", + "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", + "type": "string" } - ], - "since": "4.9.3" + ] }, { - "description": "Extracts a template", - "isasync": true, - "name": "extractTemplate", + "description": "List a storage network IP range.", + "isasync": false, + "name": "listStorageNetworkIpRange", "params": [ { - "description": "the ID of the zone where the ISO is originally located", + "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the url to which the ISO would be extracted", - "length": 2048, - "name": "url", + "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the template", + "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", "length": 255, "name": "id", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "required": false, "type": "uuid" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "", "length": 255, - "name": "mode", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, - { - "description": "the state of the extracted object", - "name": "state", - "type": "string" - }, - { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", + "name": "page", + "required": false, "type": "integer" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "the id of extracted object", - "name": "id", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" - }, + } + ], + "related": "createStorageNetworkIpRange", + "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" - }, - { - "description": "zone name the object was extracted from", - "name": "zonename", - "type": "string" - }, - { - "description": "", - "name": "resultstring", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, - {}, { - "description": "the status of the extraction", - "name": "status", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, - {}, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, { - "description": "zone ID the object was extracted from", + "description": "the Zone uuid of the storage network IP range", "name": "zoneid", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", - "type": "string" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" }, - { - "description": "type of the storage", - "name": "storagetype", - "type": "string" - } - ] - }, - { - "description": "Expunge a virtual machine. Once expunged, it cannot be recoverd.", - "isasync": true, - "name": "expungeVirtualMachine", - "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "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 storage network IP range.", + "name": "id", + "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" }, {} - ] + ], + "since": "3.0.0" }, { - "description": "Suspends a project", + "description": "Configures a virtual router element.", "isasync": true, - "name": "suspendProject", + "name": "configureVirtualRouterElement", "params": [ { - "description": "id of the project to be suspended", + "description": "the ID of the virtual router provider", "length": 255, "name": "id", - "related": "activateProject,suspendProject", + "related": "configureVirtualRouterElement", "required": true, "type": "uuid" + }, + { + "description": "Enabled/Disabled the service provider", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" } ], - "related": "activateProject", + "related": "", "response": [ - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the project name of the address", + "name": "project", "type": "string" }, {}, - {}, - { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the state of the project", - "name": "state", - "type": "string" - }, - { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" - }, { - "description": "the name of the project", - "name": "name", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "description": "the domain name where the project belongs to", + "description": "the domain associated with the provider", "name": "domain", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, + {} + ] + }, + { + "description": "Enables HA for a host", + "isasync": true, + "name": "enableHAForHost", + "params": [ { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "list" - }, + "description": "ID of the host", + "length": 255, + "name": "hostid", + "related": "reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "disableHAForHost", + "response": [ { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, + {}, + {}, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "operation status", + "name": "status", + "type": "boolean" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the id of the project", - "name": "id", - "type": "string" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" } ], - "since": "3.0.0" + "since": "4.11" }, { - "description": "Updates an IP address", + "description": "Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect.", "isasync": true, - "name": "updateIpAddress", + "name": "updateVMAffinityGroup", "params": [ { - "description": "an optional field, whether to the display the IP to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the ID of the public IP address to update", + "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "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", + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", "length": 255, - "name": "customid", + "name": "affinitygroupids", + "related": "", "required": false, - "since": "4.4", - "type": "string" + "type": "list" + }, + { + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "length": 255, + "name": "affinitygroupnames", + "related": "", + "required": false, + "type": "list" } ], - "related": "associateIpAddress,listPublicIpAddresses", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "response": [ { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" - }, - { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", - "type": "string" - }, - { - "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 name the ip address is assigned to", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "ssh key-pairs", + "name": "keypairs", "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": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "public IP address id", - "name": "id", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" - }, - { - "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 ip address", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "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" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + } + ], + "type": "set" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, - {} - ] - }, - { - "description": "Get API limit count for the caller", - "isasync": false, - "name": "getApiLimit", - "params": [], - "related": "", - "response": [ { - "description": "seconds left to reset counters", - "name": "expireAfter", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, - {}, { - "description": "the account uuid of the api remaining count", - "name": "accountid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the account name of the api remaining count", - "name": "account", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "currently allowed number of apis", - "name": "apiAllowed", - "type": "int" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "number of api already issued", - "name": "apiIssued", - "type": "int" - } - ] - }, - { - "description": "Deletes a storage network IP Range.", - "isasync": true, - "name": "deleteStorageNetworkIpRange", - "params": [ - { - "description": "the uuid of the storage network ip range", - "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "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": "3.0.0" - }, - { - "description": "moves a network to another physical network", - "isasync": true, - "name": "migrateNetwork", - "params": [ - { - "description": "the ID of the network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "true if previous network migration cmd failed", - "length": 255, - "name": "resume", - "required": false, - "type": "boolean" - }, - { - "description": "network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "", - "required": true, - "type": "uuid" - } - ], - "related": "createNetwork,updateNetwork,listNetworks", - "response": [ - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "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", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the list of resource tags associated with network", - "name": "tags", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "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": "the id of the security group rule", + "name": "ruleid", + "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain name of the security group", + "name": "domain", "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "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": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "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 id of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" } ], - "type": "list" + "type": "set" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "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": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "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": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, + {}, { - "description": "related to what other network configuration", - "name": "related", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, - {}, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the list of services", - "name": "service", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the service name", - "name": "name", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "type": "list" + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the owner of the network", - "name": "account", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the account associated with the virtual machine", + "name": "account", "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 video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "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 name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, - {}, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" - }, + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + } + ] + }, + { + "description": "Registers NCC Service Package", + "isasync": false, + "name": "registerNetscalerServicePackage", + "params": [ { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "Description of Service Package", + "length": 255, + "name": "description", + "required": true, "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "Name of the service Package.", + "length": 255, + "name": "name", + "required": true, "type": "string" - }, + } + ], + "related": "listRegisteredServicePackages", + "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Service Package UUID", + "name": "id", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "Description of Service Package", + "name": "description", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "Service Package Name", + "name": "name", "type": "string" }, + {}, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "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.11.0" + ] }, { - "description": "Adds a VMware datacenter to specified zone", + "description": "Updates a Webhook", "isasync": false, - "name": "addVmwareDc", + "name": "updateWebhook", "params": [ { - "description": "The Zone ID.", + "description": "If set to true then SSL verification will be done for the Webhook otherwise not", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "sslverification", + "required": false, + "type": "boolean" + }, + { + "description": "Scope of the Webhook", + "length": 255, + "name": "scope", + "required": false, + "type": "string" + }, + { + "description": "Payload URL of the Webhook", + "length": 255, + "name": "payloadurl", + "required": false, + "type": "string" + }, + { + "description": "The ID of the Webhook", + "length": 255, + "name": "id", + "related": "createWebhook", "required": true, "type": "uuid" }, { - "description": "Name of VMware datacenter to be added to specified zone.", + "description": "Description for the Webhook", "length": 255, - "name": "name", - "required": true, + "name": "description", + "required": false, "type": "string" }, { - "description": "The password for specified username.", + "description": "Name for the Webhook", "length": 255, - "name": "password", + "name": "name", "required": false, "type": "string" }, { - "description": "The Username required to connect to resource.", + "description": "Secret key of the Webhook", "length": 255, - "name": "username", + "name": "secretkey", "required": false, "type": "string" }, { - "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "State of the Webhook", "length": 255, - "name": "vcenter", - "required": true, + "name": "state", + "required": false, "type": "string" } ], - "related": "", "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -115873,18 +147438,54 @@ var preCache = `{ }, {}, { - "description": "the Zone ID associated with this VMware Datacenter", - "name": "zoneid", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "The VMware Datacenter name", - "name": "name", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ], + "since": "4.20.0" + }, + { + "description": "Lists the CA public certificate(s) as support by the configured/provided CA plugin", + "isasync": false, + "name": "listCaCertificate", + "params": [ { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "The CA certificate(s)", + "name": "cacertificates", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "Private key for the certificate", + "name": "privatekey", "type": "string" }, { @@ -115893,131 +147494,129 @@ var preCache = `{ "type": "string" }, { - "description": "The VMware Datacenter ID", - "name": "id", + "description": "The client certificate", + "name": "certificate", "type": "string" } - ] + ], + "since": "4.11.0" }, { - "description": "Updates Ipv6 firewall rule with specified ID", - "isasync": true, - "name": "updateIpv6FirewallRule", + "description": "Discovers available GPU devices on a host", + "isasync": false, + "name": "discoverGpuDevices", "params": [ { - "description": "the ID of the ipv6 firewall rule", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "ID of the host", "length": 255, "name": "id", - "related": "updateIpv6FirewallRule", + "related": "reconnectHost", "required": true, "type": "uuid" }, { - "description": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "", "length": 255, - "name": "protocol", + "name": "page", "required": false, + "type": "integer" + } + ], + "related": "listGpuDevices", + "response": [ + { + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the ending port of Ipv6 firewall rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", + "type": "string" }, { - "description": "the starting port of Ipv6 firewall rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "description": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" }, { - "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", + "description": "the vGPU profile name assigned to this GPU device", + "name": "virtualmachinename", "type": "string" }, { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "description": "the vGPU profile name assigned to this GPU device", + "name": "state", + "type": "state" }, { - "description": "error code for this ICMP message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "description": "the host name where the GPU device is attached", + "name": "hostname", + "type": "string" }, + {}, { - "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", - "length": 255, - "name": "traffictype", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ + "description": "the state of the virtual machine to which this GPU device is allocated", + "name": "vmstate", + "type": "state" + }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the NUMA node where the GPU device is located", + "name": "numanode", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the managed state of the GPU device (Enabled/Disabled)", + "name": "managedstate", + "type": "managedstate" }, { - "description": "the ID of the port forwarding rule", + "description": "the ID of the GPU device", "name": "id", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the host ID where the GPU device is attached", + "name": "hostid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", "type": "string" }, { @@ -116026,376 +147625,272 @@ var preCache = `{ "type": "integer" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the GPU card name associated with this GPU device", + "name": "gpucardname", "type": "string" }, + {} + ], + "since": "4.21.0" + }, + { + "description": "Provisions a host with a direct download certificate", + "isasync": false, + "name": "provisionTemplateDirectDownloadCertificate", + "params": [ { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "the host to provision the certificate", + "length": 255, + "name": "hostid", + "related": "reconnectHost", + "required": true, + "type": "uuid" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, + "description": "the id of the direct download certificate to provision", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ {}, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "indicates the details in case of failure or host skipped", + "name": "details", "type": "string" }, - {}, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the name of the host", + "name": "hostname", "type": "string" - } - ] + }, + {} + ], + "since": "4.17.0" }, { - "description": "Lists unmanaged virtual machines for a given cluster.", + "description": "Creates a Project role", "isasync": false, - "name": "listUnmanagedInstances", + "name": "updateProjectRole", "params": [ { - "description": "the cluster ID", + "description": "creates a project role with this unique name", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "ID of the Project role", + "length": 255, + "name": "id", + "related": "updateProjectRole", "required": true, "type": "uuid" }, { - "description": "the hypervisor name of the instance", + "description": "The description of the Project role", "length": 255, - "name": "name", + "name": "description", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "ID of project where role is being created", "length": 255, - "name": "keyword", - "required": false, + "name": "projectid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the id of the project", + "name": "projectid", + "type": "string" + }, + {}, + {}, + { + "description": "the name of the role", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "", + "description": "the description of the role", + "name": "description", + "type": "string" + }, + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.15.0" + }, + { + "description": "Add a new Ldap Configuration", + "isasync": false, + "name": "addLdapConfiguration", + "params": [ + { + "description": "linked domain", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomains", "required": false, + "type": "uuid" + }, + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" + }, + { + "description": "Port", + "length": 255, + "name": "port", + "required": true, "type": "integer" } ], "related": "", "response": [ { - "description": "the name of the virtual machine", - "name": "name", + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, { - "description": "the list of nics associated with the virtual machine", - "name": "nic", - "response": [ - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", - "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 IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - } - ], - "type": "set" + "description": "port the ldap server is running on", + "name": "port", + "type": "int" }, + {}, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the power state of the virtual machine", - "name": "powerstate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", + "description": "linked domain", + "name": "domainid", + "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "create Tungsten-Fabric address group", + "isasync": true, + "name": "createTungstenFabricAddressGroup", + "params": [ + { + "description": "Tungsten-Fabric ip prefix length", + "length": 255, + "name": "ipprefixlen", + "required": true, "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", + "description": "Tungsten-Fabric ip prefix", + "length": 255, + "name": "ipprefix", + "required": true, "type": "string" }, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "Tungsten-Fabric address group name", + "length": 255, + "name": "name", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ + {}, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "Tungsten-Fabric address group name", + "name": "name", "type": "string" }, { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", + "type": "string" }, { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -116403,2109 +147898,2151 @@ var preCache = `{ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", "type": "string" }, + {}, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", - "response": [ - { - "description": "the position of the disk", - "name": "position", - "type": "integer" - }, - { - "description": "the ID of the disk", - "name": "id", - "type": "string" - }, - { - "description": "the file path of the disk image", - "name": "imagepath", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "controller", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastoretype", - "type": "string" - }, - { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" - }, - { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" - }, - { - "description": "the label of the disk", - "name": "label", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorename", - "type": "string" - }, - { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" - } - ], - "type": "set" + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", + "type": "int" } - ], - "since": "4.14.0" + ] }, { - "description": "Updates ISO permissions", + "description": "Lists BigSwitch BCF Controller devices", "isasync": false, - "name": "updateIsoPermissions", + "name": "listBigSwitchBcfDevices", "params": [ { - "description": "true for featured template/iso, false otherwise", + "description": "the Physical Network ID", "length": 255, - "name": "isfeatured", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "boolean" - }, - { - "description": "the template ID", - "length": 255, - "name": "id", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, "type": "uuid" }, { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" - }, - { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "List by keyword", "length": 255, - "name": "accounts", + "name": "keyword", "required": false, - "type": "list" + "type": "string" }, { - "description": "permission operator (add, remove, reset)", + "description": "", "length": 255, - "name": "op", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true for public template/iso, false for private templates/isos", + "description": "", "length": 255, - "name": "ispublic", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "description": "bigswitch BCF controller device ID", "length": 255, - "name": "projectids", - "related": "activateProject", + "name": "bcfdeviceid", + "related": "listBigSwitchBcfDevices", "required": false, - "type": "list" + "type": "uuid" } ], + "related": "", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the controller username", + "name": "username", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the controller password", + "name": "password", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, {}, - {} - ] - }, - { - "description": "Registers an existing template into the CloudStack cloud.", - "isasync": false, - "name": "registerTemplate", - "params": [ { - "description": "true if the template supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, + "description": "NAT support", + "name": "nat", "type": "boolean" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", + "type": "string" }, { - "description": "true if the template or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "device name", + "name": "bigswitchdevicename", + "type": "string" + }, + {} + ], + "since": "4.6.0" + }, + { + "description": "lists registered service packages", + "isasync": false, + "name": "listRegisteredServicePackages", + "params": [ + { + "description": "List by keyword", "length": 255, - "name": "checksum", + "name": "keyword", "required": false, "type": "string" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "", "length": 255, - "name": "ispublic", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", + "description": "", "length": 255, - "name": "ostypeid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "description": "Description of Service Package", + "name": "description", + "type": "string" }, { - "description": "the ID of the zone the template is to be hosted on", + "description": "Service Package Name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Service Package UUID", + "name": "id", + "type": "string" + } + ] + }, + { + "description": "Change Disk offering of a Shared FileSystem", + "isasync": true, + "name": "changeSharedFileSystemDiskOffering", + "params": [ + { + "description": "the disk offering to use for the underlying storage", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "diskofferingid", + "related": "", "required": false, "type": "uuid" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "the size of the shared filesystem in GiB", "length": 255, - "name": "details", + "name": "size", "required": false, - "type": "map" + "type": "long" }, { - "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", + "description": "min iops", "length": 255, - "name": "zoneids", - "related": "createZone,listZones", + "name": "miniops", "required": false, - "type": "list" + "type": "long" }, { - "description": "the target hypervisor for the template", + "description": "the ID of the shared filesystem", "length": 255, - "name": "hypervisor", + "name": "id", + "related": "changeSharedFileSystemDiskOffering", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "description": "max iops", "length": 255, - "name": "format", - "required": true, + "name": "maxiops", + "required": false, + "type": "long" + } + ], + "related": "", + "response": [ + { + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", - "length": 255, - "name": "deployasis", - "required": false, - "since": "4.15.1", - "type": "boolean" + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", - "length": 255, - "name": "directdownload", - "required": false, - "type": "boolean" + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" }, { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", - "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", - "length": 255, - "name": "templatetype", - "required": false, - "since": "4.19.0", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "Register template for the project", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" }, { - "description": "32 or 64 bits support. 64 by default", - "length": 255, - "name": "bits", - "required": false, - "type": "integer" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "the name of the template", - "length": 255, - "name": "name", - "required": true, + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" }, { - "description": "true if this template requires HVM", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" - } - ], - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, {}, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + {}, + { + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the template ID", + "description": "ID of the shared filesystem", "name": "id", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "description of the shared filesystem", + "name": "description", "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": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the project name of the template", - "name": "project", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.20.0" + }, + { + "description": "Enables static NAT for given IP address", + "isasync": false, + "name": "enableStaticNat", + "params": [ { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the ID of the virtual machine for enabling static NAT feature", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case)", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" }, - {}, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "the public IP address ID for which static NAT feature is being enabled", + "length": 255, + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, + "description": "VM guest NIC secondary IP address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, + "type": "string" + } + ], + "response": [ { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {}, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" - }, + } + ] + }, + { + "description": "Deletes a Zone.", + "isasync": false, + "name": "deleteZone", + "params": [ { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, + "description": "the ID of the Zone", + "length": 255, + "name": "id", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + {}, { - "description": "the size of the template", - "name": "size", - "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 template", - "name": "projectid", + "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", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the template display text", + "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" } ] }, { - "description": "Deletes VPC offering", + "description": "Expunge a Shared FileSystem by id", "isasync": true, - "name": "deleteVPCOffering", + "name": "expungeSharedFileSystem", "params": [ { - "description": "the ID of the VPC offering", + "description": "the ID of the shared filesystem to expunge", "length": 255, "name": "id", - "related": "updateVPCOffering", - "required": true, + "related": "", + "required": false, "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {}, - {} - ] + } + ], + "since": "4.20.0" }, { - "description": "Adds stratosphere ssp server", + "description": "upload an existing template into the CloudStack cloud. ", "isasync": false, - "name": "addStratosphereSsp", + "name": "getUploadParamsForTemplate", "params": [ { - "description": "the zone ID", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" }, { - "description": "stratosphere ssp api name", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "name", + "name": "format", "required": true, "type": "string" }, { - "description": "stratosphere ssp api password", + "description": "Template details in key/value pairs.", "length": 255, - "name": "password", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "stratosphere ssp api username", + "description": "the tag for this template.", "length": 255, - "name": "username", + "name": "templatetag", "required": false, "type": "string" }, { - "description": "stratosphere ssp server url", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "url", - "required": true, - "type": "string" + "name": "isrouting", + "required": false, + "type": "boolean" }, { - "description": "stratosphere ssp tenant uuid", + "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", "length": 255, - "name": "tenantuuid", + "name": "ostypeid", + "related": "", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "zone which this ssp controls", - "name": "zoneid", - "type": "string" - }, - { - "description": "server id of the stratosphere ssp server", - "name": "hostid", - "type": "string" - }, - {}, - { - "description": "name", - "name": "name", - "type": "string" + "type": "uuid" }, { - "description": "url of ssp endpoint", - "name": "url", - "type": "string" + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Deletes a network ACL", - "isasync": true, - "name": "deleteNetworkACL", - "params": [ - { - "description": "the ID of the network ACL", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "id", - "related": "moveNetworkAclItem", - "required": true, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" - } - ], - "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", + "description": "true if the template or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", + "required": false, "type": "boolean" }, { - "description": "any text associated with the success or failure", + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "if true, the templates would be available for deploying CKS clusters", + "length": 255, + "name": "forcks", + "required": false, + "since": "4.21.0", + "type": "boolean" }, - {}, - {} - ] - }, - { - "description": "Creates a storage pool.", - "isasync": false, - "name": "createStoragePool", - "params": [ { - "description": "whether the storage should be managed by CloudStack", + "description": "true if this template requires HVM", "length": 255, - "name": "managed", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "the scope of the storage: cluster or zone", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "scope", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the storage provider name", + "description": "the name of the volume/template/iso", "length": 255, - "name": "provider", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the details for the storage pool", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "details", + "name": "ispublic", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "bytes CloudStack can provision from this storage pool", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "capacitybytes", + "name": "passwordenabled", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "hypervisor", + "name": "account", "required": false, "type": "string" }, { - "description": "the tags for the storage pool", + "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "tags", + "name": "checksum", "required": false, "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "istagarule", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20", + "type": "string" }, { - "description": "the Pod ID for the storage pool", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "isfeatured", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the cluster ID for the storage pool", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "deployasis", "required": false, - "type": "uuid" + "since": "4.15.1", + "type": "boolean" }, { - "description": "the URL of the storage pool", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "url", - "required": true, - "type": "string" + "name": "bits", + "required": false, + "type": "integer" }, { - "description": "the Zone ID for the storage pool", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, "name": "zoneid", - "related": "createZone,listZones", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "the name for the storage pool", + "description": "the target hypervisor for the template", "length": 255, - "name": "name", + "name": "hypervisor", "required": true, "type": "string" - }, - { - "description": "IOPS CloudStack can provision from this storage pool", - "length": 255, - "name": "capacityiops", - "required": false, - "type": "long" } ], - "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", + "related": "getUploadParamsForIso", "response": [ { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" - }, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "signature to be sent in the POST request.", + "name": "signature", + "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the timestamp after which the signature expires", + "name": "expires", "type": "string" }, - {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the template/volume ID", + "name": "id", + "type": "uuid" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" }, - { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, + } + ], + "since": "4.6.0" + }, + { + "description": "Deletes snapshot policies for the account.", + "isasync": false, + "name": "deleteSnapshotPolicies", + "params": [ { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the Id of the snapshot policy", + "length": 255, + "name": "id", + "related": "updateSnapshotPolicy", + "required": false, + "type": "uuid" }, + { + "description": "list of snapshots policy IDs separated by comma", + "length": 255, + "name": "ids", + "related": "updateSnapshotPolicy", + "required": false, + "type": "list" + } + ], + "response": [ {}, { - "description": "the storage pool path", - "name": "path", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "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 the entity/resource has annotations", - "name": "hasannotations", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" - }, - { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" - }, + } + ] + }, + { + "description": "delete Netris Provider to CloudStack", + "isasync": false, + "name": "deleteNetrisProvider", + "params": [ { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" - }, + "description": "Netris Provider ID", + "length": 255, + "name": "id", + "related": "deleteNetrisProvider", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the scope of the storage pool", - "name": "scope", + "description": "Netris Provider name", + "name": "name", "type": "string" }, + {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "Zone ID to which the Netris Provider is associated with", + "name": "zoneid", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "Netris Provider site", + "name": "sitename", + "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "Netris provider uuid", + "name": "uuid", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "Zone name to which the Netris Provider is associated with", + "name": "zonename", "type": "string" }, + {}, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "Netris Admin tenant name", + "name": "tenantname", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "Netris Tag for vNets", + "name": "netristag", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "Netris Provider URL", + "name": "netrisurl", "type": "string" } - ] + ], + "since": "4.21.0" }, { - "description": "Lists storage pools available for migration of a volume.", + "description": "Lists implementors of implementor of a network traffic type or implementors of all network traffic types", "isasync": false, - "name": "findStoragePoolsForMigration", + "name": "listTrafficTypeImplementors", "params": [ { - "description": "the ID of the volume", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "", + "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", "length": 255, - "name": "page", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], - "related": "cancelStorageMaintenance,enableStorageMaintenance", + "related": "", "response": [ { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the storage pool path", - "name": "path", + "description": "network traffic type", + "name": "traffictype", "type": "string" }, {}, + {}, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" - }, - { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "implementor of network traffic type", + "name": "traffictypeimplementor", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "list the db hosts and statistics", + "isasync": false, + "name": "listDbMetrics", + "params": [], + "related": "", + "response": [ { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the uptime of the DB in seconds", + "name": "uptime", + "type": "long" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the number of connections to the DB", + "name": "connections", + "type": "int" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "the number of queries performed on the DB", + "name": "queries", "type": "long" }, - { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the tls versions currently in use (accepted) by the DB", + "name": "tlsversions", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the state of the usage server", + "name": "replicas", + "type": "string[]" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the name of the active usage server", + "name": "hostname", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the version of the currently running DB", + "name": "version", "type": "string" }, + {}, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the last measured load averages on the DB", + "name": "dbloadaverages", + "type": "double[]" + }, + { + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, + { + "description": "the version of the currently running DB", + "name": "versioncomment", + "type": "string" + } + ], + "since": "4.17.0" + }, + { + "description": "Deletes an image store or Secondary Storage.", + "isasync": false, + "name": "deleteImageStore", + "params": [ + { + "description": "The image store ID or Secondary Storage ID.", + "length": 255, + "name": "id", + "related": "listSwifts", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "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": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, + {} + ], + "since": "4.2.0" + }, + { + "description": "Lists autoscale vm profiles.", + "isasync": false, + "name": "listAutoScaleVmProfiles", + "params": [ { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "list profiles by service offering id", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.4", + "type": "uuid" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "the templateid of the autoscale vm profile", + "length": 255, + "name": "templateid", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" }, - {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "availability zone for the auto deployed virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "since": "4.4", + "type": "uuid" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "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": "the name of the storage pool", - "name": "name", + "description": "the otherdeployparameters of the autoscale vm profile", + "length": 255, + "name": "otherdeployparams", + "required": false, "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" - } - ] - }, - { - "description": "create Tungsten-Fabric tag", - "isasync": true, - "name": "createTungstenFabricTag", - "params": [ + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { - "description": "Tungsten-Fabric tag type", + "description": "", "length": 255, - "name": "tagtype", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of zone", + "description": "the ID of the autoscale vm profile", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, + "name": "id", + "related": "listAutoScaleVmProfiles", + "required": false, "type": "uuid" }, { - "description": "Tungsten-Fabric tag value", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "tagvalue", - "required": true, - "type": "string" + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" } ], "related": "", "response": [ - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" + "description": "the project id vm profile", + "name": "projectid", + "type": "string" }, + {}, { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" + "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" + "description": "the domain ID of the vm profile", + "name": "domainid", + "type": "string" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - } - ] - }, - { - "description": "Adds an OpenDyalight controler", - "isasync": true, - "name": "addOpenDaylightController", - "params": [ + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" + }, { - "description": "Username to access the OpenDaylight API", - "length": 255, - "name": "username", - "required": true, + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "Credential to access the OpenDaylight API", - "length": 255, - "name": "password", - "required": true, + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "Api URL of the OpenDaylight Controller.", - "length": 255, - "name": "url", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "device id of the controller", - "name": "id", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, { - "description": "the name assigned to the controller", - "name": "name", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the url of the controller api", - "name": "url", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "delete Tungsten-Fabric firewall rule", - "isasync": true, - "name": "deleteTungstenFabricFirewallRule", - "params": [ + }, { - "description": "the uuid of Tungsten-Fabric firewall rule", - "length": 255, - "name": "firewallruleuuid", - "required": true, + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the project name of the vm profile", + "name": "project", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, { - "description": "Creates a Zone.", - "isasync": false, - "name": "createZone", + "description": "Authorizes a particular ingress rule for this security group", + "isasync": true, + "name": "authorizeSecurityGroupIngress", "params": [ { - "description": "true if the zone is an edge zone, false otherwise", + "description": "an optional project of the security group", "length": 255, - "name": "isedge", + "name": "projectid", + "related": "", "required": false, - "since": "4.18.0", - "type": "boolean" + "type": "uuid" }, { - "description": "true if network is security group enabled, false otherwise", + "description": "user to security group mapping", "length": 255, - "name": "securitygroupenabled", + "name": "usersecuritygrouplist", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the guest CIDR address for the Zone", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.", "length": 255, - "name": "guestcidraddress", + "name": "protocol", "required": false, "type": "string" }, { - "description": "the second DNS for the Zone", + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "dns2", + "name": "cidrlist", "required": false, - "type": "string" - }, - { - "description": "network type of the zone, can be Basic or Advanced", - "length": 255, - "name": "networktype", - "required": true, - "type": "string" + "type": "list" }, { - "description": "the name of the Zone", + "description": "error code for this icmp message", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "icmpcode", + "required": false, + "type": "integer" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "ip6dns2", + "name": "securitygroupname", "required": false, "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "internaldns1", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "start port for this ingress rule", "length": 255, - "name": "localstorageenabled", + "name": "startport", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "ip6dns1", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Allocation state of this Zone for allocation of new resources", + "description": "type of the icmp message being sent", "length": 255, - "name": "allocationstate", + "name": "icmptype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the containing domain, null for public zones", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "securitygroupid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the second internal DNS for the Zone", + "description": "end port for this ingress rule", "length": 255, - "name": "internaldns2", + "name": "endport", "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "length": 255, - "name": "domain", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the first DNS for the Zone", - "length": 255, - "name": "dns1", - "required": true, - "type": "string" - } - ], - "related": "listZones", - "response": [ + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, + {}, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "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": "Zone name", - "name": "name", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, {}, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the Zone ID", - "name": "zoneid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "list" + "type": "set" }, - {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Sync storage pool with management server (currently supported for Datastore Cluster in VMware and syncs the datastores in it)", + "isasync": true, + "name": "syncStoragePool", + "params": [ { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "Storage pool id", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": true, + "type": "uuid" + } + ], + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", + "response": [ + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "Zone id", - "name": "id", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "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": "the project id the tag belongs to", - "name": "projectid", - "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": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, + {}, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" - } - ] - }, - { - "description": "disable a Cisco Nexus VSM device", - "isasync": true, - "name": "disableCiscoNexusVSM", - "params": [ + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, { - "description": "Id of the Cisco Nexus 1000v VSM device to be deleted", - "length": 255, - "name": "id", - "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", - "required": true, - "type": "uuid" - } - ], - "related": "listCiscoNexusVSMs", - "response": [ + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "device state", - "name": "vsmdevicestate", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", - "type": "string" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + } + ], + "since": "4.15.1" + }, + { + "description": "Updates Bucket properties", + "isasync": false, + "name": "updateBucket", + "params": [ + { + "description": "The ID of the Bucket", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "Bucket Access Policy", + "length": 255, + "name": "policy", + "required": false, "type": "string" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" + "description": "Enable/Disable Bucket encryption", + "length": 255, + "name": "encryption", + "required": false, + "type": "boolean" + }, + { + "description": "Enable/Disable Bucket Versioning", + "length": 255, + "name": "versioning", + "required": false, + "type": "boolean" + }, + { + "description": "Bucket Quota in GiB", + "length": 255, + "name": "quota", + "required": false, + "type": "integer" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { - "description": "device name", - "name": "vsmdevicename", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.19.0" }, { - "description": "Creates a Storage network IP range.", - "isasync": true, - "name": "createStorageNetworkIpRange", + "description": "Recalculate and update resource count for an account or domain. This also executes some cleanup tasks before calculating resource counts.", + "isasync": false, + "name": "updateResourceCount", "params": [ { - "description": "UUID of pod where the ip range belongs to", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "the ending IP address", + "description": "Update resource count for a specified account. Must be used with the domainId parameter.", "length": 255, - "name": "endip", + "name": "account", "required": false, "type": "string" }, { - "description": "the beginning IP address", + "description": "Update resource limits for project", "length": 255, - "name": "startip", - "required": true, - "type": "string" + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table", + "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - 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. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", "length": 255, - "name": "vlan", + "name": "resourcetype", "required": false, "type": "integer" }, { - "description": "the gateway for storage network", + "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", "length": 255, - "name": "gateway", + "name": "domainid", + "related": "listDomains", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the netmask for storage network", + "description": "Tag for the resource type", "length": 255, - "name": "netmask", - "required": true, + "name": "tag", + "required": false, + "since": "4.20.0", "type": "string" } ], "related": "", "response": [ { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the account for which resource count's are updated", + "name": "account", "type": "string" }, + {}, { - "description": "the end ip of the storage network IP range", - "name": "endip", - "type": "string" + "description": "The resource count", + "name": "resourcecount", + "type": "long" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, + { + "description": "the domain name for which resource count's are updated", + "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", + "name": "resourcetype", "type": "string" }, { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "the project name for which resource count's are updated", + "name": "project", "type": "string" }, - {}, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the domain ID for which resource count's are updated", + "name": "domainid", "type": "string" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the project id for which resource count's are updated", + "name": "projectid", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" - }, - { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "path of the domain to which the resource counts are updated", + "name": "domainpath", "type": "string" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "Tag for the resource", + "name": "tag", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Lists all children domains belonging to a specified domain", + "description": "Lists dynamic roles in CloudStack", "isasync": false, - "name": "listDomainChildren", + "name": "listRoles", "params": [ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "flag to display the resource icon for domains", + "description": "List role by role ID.", "length": 255, - "name": "showicon", + "name": "id", + "related": "listRoles", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "List by keyword", @@ -118517,400 +150054,383 @@ var preCache = `{ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list children domain by parent domain ID.", + "description": "List role by role type status, valid options are: enabled, disabled", "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list children domains by name", + "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", "length": 255, - "name": "name", + "name": "type", "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", + "description": "List role by role name.", "length": 255, - "name": "listall", + "name": "name", "required": false, - "type": "boolean" + "type": "string" } ], - "related": "listDomains", + "related": "", "response": [ { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the description of the role", + "name": "description", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" - }, - { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the name of the role", + "name": "name", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the state of the role", + "name": "state", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" + } + ], + "since": "4.9.0" + }, + { + "description": "list Tungsten-Fabric policy", + "isasync": false, + "name": "listTungstenFabricPolicy", + "params": [ { - "description": "the network domain", - "name": "networkdomain", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": false, "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of ip address", + "length": 255, + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" }, { - "description": "the path of the domain", - "name": "path", - "type": "string" - }, + "description": "the ID of network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, + {}, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { - "description": "the state of the domain", - "name": "state", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, + {} + ] + }, + { + "description": "Download object at a specified path on an image store.", + "isasync": true, + "name": "downloadImageStoreObject", + "params": [ { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "path to download on image store", + "length": 255, + "name": "path", + "required": false, "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" - }, - { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" - }, + "description": "id of the image store", + "length": 255, + "name": "id", + "related": "listSwifts", + "required": true, + "type": "uuid" + } + ], + "related": "extractSnapshot,extractTemplate", + "response": [ { - "description": "the name of the domain", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", - "type": "string" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the domain", + "description": "the id of extracted object", "name": "id", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, - { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" - }, {}, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", + "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" } - ] + ], + "since": "4.19.0" }, { - "description": "Returns an encrypted password for the VM", + "description": "Retrieves a cloud identifier.", "isasync": false, - "name": "getVMPassword", + "name": "getCloudIdentifier", "params": [ { - "description": "The ID of the virtual machine", + "description": "the user ID for the cloud identifier", "length": 255, - "name": "id", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "userid", + "related": "getUser", "required": true, "type": "uuid" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the cloud identifier", + "name": "cloudidentifier", + "type": "string" + }, + { + "description": "the signed response for the cloud identifier", + "name": "signature", + "type": "string" + }, {}, { - "description": "The base64 encoded encrypted password of the VM", - "name": "encryptedpassword", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the user ID for the cloud identifier", + "name": "userid", "type": "string" } ] }, { - "description": "Assign load balancer rule or list of load balancer rules to a global load balancer rules.", + "description": "Creates a load balancer stickiness policy ", "isasync": true, - "name": "assignToGlobalLoadBalancerRule", + "name": "createLBStickinessPolicy", "params": [ { - "description": "the ID of the global load balancer rule", + "description": "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", "length": 255, - "name": "id", - "related": "", + "name": "methodname", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the list load balancer rules that will be assigned to global load balancer rule", + "description": "name of the load balancer stickiness policy", "length": 255, - "name": "loadbalancerrulelist", - "related": "", + "name": "name", "required": true, - "type": "list" + "type": "string" }, { - "description": "Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'", + "description": "the description of the load balancer stickiness policy", "length": 255, - "name": "gslblbruleweightsmap", + "name": "description", "required": false, - "type": "map" - } - ], - "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", + "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" - } - ] - }, - { - "description": "Configures an ovs element.", - "isasync": true, - "name": "configureOvsElement", - "params": [ + }, { - "description": "Enabled/Disabled the service provider", + "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" + "name": "param", + "required": false, + "type": "map" }, { - "description": "the ID of the ovs provider", + "description": "the ID of the load balancer rule", "length": 255, - "name": "id", - "related": "configureOvsElement", + "name": "lbruleid", + "related": "", "required": true, "type": "uuid" } @@ -118918,45 +150438,87 @@ var preCache = `{ "related": "", "response": [ { - "description": "the account associated with the provider", - "name": "account", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" }, + {}, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", + "response": [ + { + "description": "the params of the policy", + "name": "params", + "type": "map" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, + { + "description": "the LB Stickiness policy ID", + "name": "id", + "type": "string" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "the method name of the Stickiness policy", + "name": "methodname", + "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + {}, + { + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the ovs", - "name": "id", + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { @@ -118965,422 +150527,318 @@ var preCache = `{ "type": "integer" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "Adds S3 Image Store", + "description": "Adds a Cisco Asa 1000v appliance", "isasync": false, - "name": "addImageStoreS3", + "name": "addCiscoAsa1000vResource", "params": [ { - "description": "S3 secret key", + "description": "the Cluster ID", "length": 255, - "name": "secretkey", + "name": "clusterid", + "related": "addCluster", "required": true, - "type": "string" - }, - { - "description": "Use HTTPS instead of HTTP", - "length": 255, - "name": "usehttps", - "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "S3 access key", + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", "length": 255, - "name": "accesskey", + "name": "hostname", "required": true, "type": "string" }, { - "description": "Whether TCP keep-alive is used", - "length": 255, - "name": "usetcpkeepalive", - "required": false, - "type": "boolean" - }, - { - "description": "Connection timeout (milliseconds)", - "length": 255, - "name": "connectiontimeout", - "required": false, - "type": "integer" - }, - { - "description": "Maximum number of times to retry on error", - "length": 255, - "name": "maxerrorretry", - "required": false, - "type": "integer" - }, - { - "description": "Socket timeout (milliseconds)", - "length": 255, - "name": "sockettimeout", - "required": false, - "type": "integer" - }, - { - "description": "Connection TTL (milliseconds)", - "length": 255, - "name": "connectionttl", - "required": false, - "type": "integer" - }, - { - "description": "Name of the storage bucket", + "description": "Nexus port profile associated with inside interface of ASA 1000v", "length": 255, - "name": "bucket", + "name": "insideportprofile", "required": true, "type": "string" }, { - "description": "S3 endpoint", + "description": "the Physical Network ID", "length": 255, - "name": "endpoint", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "string" - }, - { - "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", - "length": 255, - "name": "s3signer", - "required": false, - "type": "string" + "type": "uuid" } ], - "related": "listImageStores", + "related": "", "response": [ + {}, { - "description": "the url of the image store", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" - }, - { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - }, {}, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the ID of the image store", - "name": "id", - "type": "string" - }, {}, - { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the image store", - "name": "name", - "type": "string" - }, - { - "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 scope of the image store", - "name": "scope", - "type": "scopetype" - }, - { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - } - ], - "since": "4.7.0" + {} + ] }, { - "description": "Upload a certificate for HTTPS direct template download on KVM hosts", - "isasync": false, - "name": "uploadTemplateDirectDownloadCertificate", + "description": "Configures a Palo Alto firewall device", + "isasync": true, + "name": "configurePaloAltoFirewall", "params": [ { - "description": "Name for the uploaded certificate", + "description": "capacity of the firewall device, Capacity will be interpreted as number of networks device can handle", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "fwdevicecapacity", + "required": false, + "type": "long" }, { - "description": "Zone to upload certificate", + "description": "Palo Alto firewall device ID", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "fwdeviceid", + "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", "required": true, "type": "uuid" - }, + } + ], + "related": "listPaloAltoFirewalls", + "response": [ { - "description": "(optional) the host ID to upload certificate", - "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" + "description": "the management IP address of the external firewall", + "name": "ipaddress", + "type": "string" }, { - "description": "SSL certificate", - "length": 65535, - "name": "certificate", - "required": true, + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "Hypervisor type", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "device state", + "name": "fwdevicestate", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the direct download certificate alias", - "name": "alias", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" }, { - "description": "the direct download certificate id", - "name": "id", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the direct download certificate version", - "name": "version", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the direct download certificate issuer", - "name": "validity", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the direct download certificate serial num", - "name": "serialnum", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the direct download certificate subject", - "name": "subject", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the direct download certificate issuer", - "name": "issuer", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" + "description": "name of the provider", + "name": "provider", + "type": "string" }, { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, - {} - ], - "since": "4.11.0" + {}, + { + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", + "type": "string" + }, + { + "description": "the public security zone of the external firewall", + "name": "publiczone", + "type": "string" + } + ] }, { - "description": "Import unmanaged virtual machine from a given cluster.", + "description": "Updates ACL item with specified ID", "isasync": true, - "name": "importUnmanagedInstance", + "name": "updateNetworkACLItem", "params": [ { - "description": "import instance for the project", + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "cidrlist", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "nicipaddresslist", + "name": "reason", "required": false, - "type": "map" + "type": "string" }, { - "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "description": "scl entry action, allow or deny", "length": 255, - "name": "migrateallowed", + "name": "action", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the template for the virtual machine", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "the display name of the instance", + "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "displayname", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "datadiskofferinglist", + "name": "protocol", "required": false, - "type": "map" + "type": "string" }, { - "description": "the cluster ID", + "description": "the ending port of ACL", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" + "name": "endport", + "required": false, + "type": "integer" }, { - "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", + "description": "Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'.", "length": 255, - "name": "forced", + "name": "partialupgrade", "required": false, "type": "boolean" }, { - "description": "the service offering for the virtual machine", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "used to specify the custom parameters.", + "description": "The network of the vm the ACL will be created for", "length": 255, - "name": "details", + "name": "number", "required": false, - "type": "map" + "type": "integer" }, { - "description": "the name of the instance as it is known to the hypervisor", + "description": "the ID of the network ACL item", "length": 255, - "name": "name", + "name": "id", + "related": "updateNetworkACLItem,moveNetworkAclItem", "required": true, - "type": "string" - }, - { - "description": "import instance to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "type of the ICMP message being sent", "length": 255, - "name": "account", + "name": "icmptype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the host name of the instance", + "description": "the starting port of ACL", "length": 255, - "name": "hostname", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "VM nic to network id mapping using keys nic and network", + "description": "error code for this ICMP message", "length": 255, - "name": "nicnetworklist", + "name": "icmpcode", "required": false, - "type": "map" + "type": "integer" } ], - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "related": "moveNetworkAclItem", "response": [ { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -119394,23 +150852,18 @@ var preCache = `{ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -119419,811 +150872,568 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the state of the rule", + "name": "state", "type": "string" }, - {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the traffic type for the ACL", + "name": "traffictype", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, - {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "is rule for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, + {}, + { + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + } + ] + }, + { + "description": "List routers.", + "isasync": false, + "name": "listRouters", + "params": [ + { + "description": "the host ID of the router", + "length": 255, + "name": "hostid", + "related": "reconnectHost", + "required": false, + "type": "uuid" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "list virtual router elements by version", + "length": 255, + "name": "version", + "required": false, "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "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" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", + "length": 255, + "name": "fetchhealthcheckresults", + "required": false, + "since": "4.14", + "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the Pod ID of the router", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the Zone ID of the router", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the ID of the disk router", + "length": 255, + "name": "id", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "uuid" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the state of the router", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "List networks by VPC", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "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 account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "if true is passed for this parameter, list only VPC routers", + "length": 255, + "name": "forvpc", + "required": false, + "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "if this parameter is passed, list only routers by health check results", + "length": 255, + "name": "healthchecksfailed", + "required": false, + "since": "4.16", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the cluster ID of the router", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": false, + "type": "uuid" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the router", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "CPU arch of the router", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20.1", "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the hostname for the router", + "name": "hostname", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" }, + {}, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the host ID for the router", + "name": "hostid", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the project name of the address", + "name": "project", "type": "string" }, + {}, { - "description": "the ID of the availability zone for the virtual machine", + "description": "the Zone ID for the router", "name": "zoneid", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "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" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "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" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ], - "type": "set" + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, - {}, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" }, { - "description": "the list of nics associated with vm", + "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, { "description": "the ip address of the nic", "name": "ipaddress", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { "description": "the isolated private VLAN if available", @@ -120231,14 +151441,14 @@ var preCache = `{ "type": "integer" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the netmask of the nic", @@ -120246,184 +151456,176 @@ var preCache = `{ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { "description": "the IPv6 address of network", "name": "ip6address", "type": "string" }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, { "description": "the name of the corresponding network", "name": "networkname", "type": "string" - } - ], - "type": "set" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" } ], "type": "set" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" } - ], - "since": "4.14.0" + ] }, { - "description": "Lists System VM stats", + "description": "list Tungsten-Fabric vm", "isasync": false, - "name": "listSystemVmsUsageHistory", + "name": "listTungstenFabricVm", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, - { - "description": "the ID of the system VM.", + "description": "the uuid of Tungsten-Fabric vm", "length": 255, - "name": "id", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "name": "vmuuid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "List by keyword", @@ -120433,26 +151635,19 @@ var preCache = `{ "type": "string" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, - { - "description": "name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the IDs of the system VMs, mutually exclusive with id.", + "description": "the ID of zone", "length": 255, - "name": "ids", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "list" + "type": "uuid" }, { "description": "", @@ -120465,47 +151660,46 @@ var preCache = `{ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric nic uuid", + "name": "uuid", + "type": "string" }, + {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the list of VM stats", - "name": "stats", - "type": "list" + "description": "Tungsten-Fabric vm 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" } - ], - "since": "4.18.0" + ] }, { - "description": "Deletes a IPv6 firewall rule", + "description": "Deletes a Physical Network.", "isasync": true, - "name": "deleteIpv6FirewallRule", + "name": "deletePhysicalNetwork", "params": [ { - "description": "the ID of the IPv6 firewall rule", + "description": "the ID of the Physical network", "length": 255, "name": "id", "related": "", @@ -120516,43 +151710,64 @@ var preCache = `{ "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} - ] + } + ], + "since": "3.0.0" }, { - "description": "Creates a physical network", + "description": "add Tungsten-Fabric policy rule", "isasync": true, - "name": "createPhysicalNetwork", + "name": "addTungstenFabricPolicyRule", "params": [ { - "description": "domain ID of the account owning a physical network", + "description": "Tungsten-Fabric policy rule destination network", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "name": "destnetwork", + "required": true, + "type": "string" }, { - "description": "the Zone ID for the physical network", + "description": "Tungsten-Fabric policy rule source network", + "length": 255, + "name": "srcnetwork", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric policy rule direction", + "length": 255, + "name": "direction", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric policy rule source ip prefix length", + "length": 255, + "name": "srcipprefixlen", + "required": true, + "type": "integer" + }, + { + "description": "the ID of zone", "length": 255, "name": "zoneid", "related": "listZones", @@ -120560,159 +151775,206 @@ var preCache = `{ "type": "uuid" }, { - "description": "the VLAN for the physical network", + "description": "Tungsten-Fabric policy rule source ip prefix", "length": 255, - "name": "vlan", - "required": false, + "name": "srcipprefix", + "required": true, "type": "string" }, { - "description": "Tag the physical network", + "description": "Tungsten-Fabric policy rule source start port", "length": 255, - "name": "tags", - "required": false, - "type": "list" + "name": "srcstartport", + "required": true, + "type": "integer" }, { - "description": "the isolation method for the physical network[VLAN/L3/GRE]", + "description": "Tungsten-Fabric policy rule destination start port", "length": 255, - "name": "isolationmethods", - "required": false, - "type": "list" + "name": "deststartport", + "required": true, + "type": "integer" }, { - "description": "the name of the physical network", + "description": "Tungsten-Fabric policy rule destination ip prefix", "length": 255, - "name": "name", + "name": "destipprefix", "required": true, "type": "string" }, { - "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", + "description": "Tungsten-Fabric policy rule protocol", "length": 255, - "name": "broadcastdomainrange", - "required": false, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "the speed for the physical network[1G/10G]", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "networkspeed", - "required": false, + "name": "policyuuid", + "required": true, "type": "string" + }, + { + "description": "Tungsten-Fabric policy rule source end port", + "length": 255, + "name": "srcendport", + "required": true, + "type": "integer" + }, + { + "description": "Tungsten-Fabric policy rule action", + "length": 255, + "name": "action", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric policy rule destination end port", + "length": 255, + "name": "destendport", + "required": true, + "type": "integer" + }, + { + "description": "Tungsten-Fabric policy rule destination ip prefix length", + "length": 255, + "name": "destipprefixlen", + "required": true, + "type": "integer" } ], "related": "", "response": [ { - "description": "the speed of the physical network", - "name": "networkspeed", - "type": "string" + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", + "type": "int" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "Tungsten-Fabric policy action", + "name": "action", "type": "string" }, { - "description": "state of the physical network", - "name": "state", - "type": "string" + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" }, { - "description": "comma separated tag", - "name": "tags", + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "Tungsten-Fabric policy name", + "name": "direction", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", - "type": "string" + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", + "type": "int" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "the uuid of the physical network", - "name": "id", + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" }, { - "description": "name of the physical network", - "name": "name", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", "type": "string" }, + { + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" + }, {}, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Lists autoscale vm groups.", + "description": "Creates a Webhook", "isasync": false, - "name": "listAutoScaleVmGroups", + "name": "createWebhook", "params": [ { - "description": "the name of the autoscale vmgroup", + "description": "Secret key of the Webhook", "length": 255, - "name": "name", + "name": "secretkey", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the profile", + "description": "State of the Webhook", "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the policy", + "description": "Project for the Webhook", "length": 255, - "name": "policyid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "an optional domainId for the Webhook. If the account parameter is used, domainId must also be used.", "length": 255, "name": "domainid", "related": "listDomains", @@ -120720,409 +151982,278 @@ var preCache = `{ "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": "the ID of the loadbalancer", - "length": 255, - "name": "lbruleid", - "related": "", - "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": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "An optional account for the Webhook. Must be used with domainId.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "", + "description": "Payload URL of the Webhook", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "payloadurl", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "Scope of the Webhook", "length": 255, - "name": "keyword", + "name": "scope", "required": false, "type": "string" }, { - "description": "the availability zone ID", + "description": "Description for the Webhook", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the autoscale vm group", + "description": "If set to true then SSL verification will be done for the Webhook otherwise not", "length": 255, - "name": "id", - "related": "listAutoScaleVmGroups", + "name": "sslverification", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Name for the Webhook", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "name", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" - }, - { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" - }, - { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the public ip address", - "name": "publicip", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "The account associated with the Webhook", + "name": "account", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" - }, - { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" - }, - { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" - }, - { - "description": "the project name of the vm group", + "description": "the project name of the Kubernetes cluster", "name": "project", "type": "string" }, + {}, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the project id of the vm group", - "name": "projectid", + "description": "The name of the Webhook", + "name": "name", "type": "string" }, + {}, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" - }, - { - "description": "the autoscale vm group ID", - "name": "id", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "The secret key for the Webhook", + "name": "secretkey", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, - {}, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "The state of the Webhook", + "name": "state", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "The ID of the Webhook", + "name": "id", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account owning the vm group", - "name": "account", - "type": "string" + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" }, { - "description": "the public port", - "name": "publicport", + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "Creates a firewall rule for a given IP address", + "description": "Removes vpn user", "isasync": true, - "name": "createFirewallRule", + "name": "removeVpnUser", "params": [ { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "fordisplay", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "error code for this icmp message", + "description": "username for the vpn user", "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "name": "username", + "required": true, + "type": "string" }, { - "description": "the ending port of firewall rule", + "description": "an optional account for the vpn user. Must be used with domainId.", "length": 255, - "name": "endport", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "remove vpn user from the project", "length": 255, - "name": "cidrlist", + "name": "projectid", + "related": "", "required": false, - "type": "list" - }, - { - "description": "the IP address id of the port forwarding rule", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses", - "required": true, "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "type of firewallrule: system/user", - "length": 255, - "name": "type", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", - "length": 255, - "name": "protocol", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {} + ] + }, + { + "description": "List public IP addresses in quarantine.", + "isasync": false, + "name": "listQuarantinedIps", + "params": [ { - "description": "the starting port of firewall rule", + "description": "", "length": 255, - "name": "startport", + "name": "page", "required": false, "type": "integer" - } - ], - "related": "updateEgressFirewallRule", - "response": [ - {}, + }, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "Show IPs removed from quarantine.", + "length": 255, + "name": "showremoved", + "required": false, + "type": "boolean" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" + "description": "Show IPs that are no longer in quarantine.", + "length": 255, + "name": "showinactive", + "required": false, + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "list" - }, + } + ], + "related": "updateQuarantinedIp", + "response": [ { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", + "type": "string" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", + "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "ID of the quarantine process.", + "name": "id", "type": "string" }, + {}, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" + "description": "When the quarantine was created.", + "name": "created", + "type": "date" }, { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" }, + {}, { - "description": "the public ip address for the firewall rule", + "description": "The public IP address in quarantine.", "name": "ipaddress", "type": "string" }, @@ -121132,435 +152263,427 @@ var preCache = `{ "type": "integer" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - {} - ] + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" + } + ], + "since": "4.19" }, { - "description": "Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.", + "description": "Deletes a load balancer health check policy.", "isasync": true, - "name": "createVolume", + "name": "deleteLBHealthCheckPolicy", "params": [ { - "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", + "description": "the ID of the load balancer health check policy", "length": 255, - "name": "virtualmachineid", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", - "required": false, + "name": "id", + "related": "", + "required": true, "type": "uuid" - }, + } + ], + "response": [ { - "description": "the account associated with the disk volume. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "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, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", - "length": 255, - "name": "snapshotid", - "related": "listSnapshots", - "required": false, - "type": "uuid" - }, - { - "description": "an optional field, whether to display the volume to the end user or not.", - "length": 255, - "name": "displayvolume", - "required": false, - "type": "boolean" - }, - { - "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Arbitrary volume size", - "length": 255, - "name": "size", - "required": false, - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {} + ], + "since": "4.2.0" + }, + { + "description": "List Swift.", + "isasync": false, + "name": "listSwifts", + "params": [ { - "description": "min iops", + "description": "the id of the swift", "length": 255, - "name": "miniops", + "name": "id", "required": false, "type": "long" }, { - "description": "the project associated with the volume. Mutually exclusive with account parameter", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", + "description": "", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the name of the disk volume", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "max iops", - "length": 255, - "name": "maxiops", - "required": false, - "type": "long" - }, - { - "description": "the ID of the availability zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], - "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "", "response": [ { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, - { - "description": "name of the disk volume", + "description": "the name of the image store", "name": "name", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, + {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, + {}, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "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 account associated with the disk volume", - "name": "account", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Disables HA for a host", + "isasync": true, + "name": "disableHAForHost", + "params": [ { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the host", + "length": 255, + "name": "hostid", + "related": "reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, + {}, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "operation status", + "name": "status", + "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + } + ], + "since": "4.11" + }, + { + "description": "Enables out-of-band management for a host", + "isasync": true, + "name": "enableOutOfBandManagementForHost", + "params": [ + { + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", "type": "boolean" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, + {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "pod id of the volume", - "name": "podid", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" - }, + } + ], + "since": "4.9.0" + }, + { + "description": "Deletes a service offering.", + "isasync": false, + "name": "deleteServiceOffering", + "params": [ { - "description": "pod name of the volume", - "name": "podname", + "description": "the ID of the service offering", + "length": 255, + "name": "id", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the disk utilization", - "name": "utilization", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ] + }, + { + "description": "Lists supported Kubernetes version", + "isasync": false, + "name": "listKubernetesSupportedVersions", + "params": [ { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the ID of the Kubernetes supported version", + "length": 255, + "name": "id", + "related": "listKubernetesSupportedVersions", + "required": false, + "type": "uuid" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the minimum semantic version for the Kubernetes supported version to be listed", + "length": 255, + "name": "minimumsemanticversion", + "required": false, "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, - {}, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the ID of the zone in which Kubernetes supported version will be available", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the CPU arch of the binaries ISO. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, + "description": "the ID of the minimum Kubernetes supported version", + "length": 255, + "name": "minimumkubernetesversionid", + "related": "listKubernetesSupportedVersions", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -121568,720 +152691,532 @@ var preCache = `{ "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", "type": "string" }, + {}, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", + "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, + {}, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", + "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, { - "description": "the status of the volume", - "name": "status", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, - {}, - { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" } ] }, { - "description": "List virtual machine snapshot by conditions", - "isasync": false, - "name": "listVMSnapshot", + "description": "Adds a Nicira NVP device", + "isasync": true, + "name": "addNiciraNvpDevice", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "List by keyword", + "description": "The L2 Gateway Service UUID configured on the Nicira Controller", "length": 255, - "name": "keyword", + "name": "l2gatewayserviceuuid", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "The Transportzone UUID configured on the Nicira Controller", "length": 255, - "name": "account", - "required": false, + "name": "transportzoneuuid", + "required": true, "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" - }, - { - "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", - "length": 255, - "name": "vmsnapshotids", - "related": "listVMSnapshot,createVMSnapshot", - "required": false, - "since": "4.9", - "type": "list" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Credentials to access the Nicira Controller API", "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" + "name": "password", + "required": true, + "type": "string" }, { - "description": "The ID of the VM snapshot", + "description": "Hostname of ip address of the Nicira NVP Controller.", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": false, - "type": "uuid" + "name": "hostname", + "required": true, + "type": "string" }, { - "description": "the ID of the vm", + "description": "the Physical Network ID", "length": 255, - "name": "virtualmachineid", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", - "required": false, + "name": "physicalnetworkid", + "related": "", + "required": true, "type": "uuid" }, { - "description": "lists snapshot by snapshot name or display name", + "description": "Credentials to access the Nicira Controller API", "length": 255, - "name": "name", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "The L3 Gateway Service UUID configured on the Nicira Controller", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "l3gatewayserviceuuid", "required": false, - "type": "uuid" - }, + "type": "string" + } + ], + "related": "", + "response": [ { - "description": "state of the virtual machine snapshot", - "length": 255, - "name": "state", - "required": false, + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - } - ], - "related": "createVMSnapshot", - "response": [ - { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" }, + {}, { - "description": "the ID of the vm snapshot", - "name": "id", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" - }, - { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, { - "description": "the description of the vm snapshot", - "name": "description", + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "type": "string" }, { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "description": "device name", + "name": "niciradevicename", "type": "string" }, { - "description": "VM Snapshot type", - "name": "type", + "description": "name of the provider", + "name": "provider", "type": "string" - }, + } + ] + }, + { + "description": "Lists infrastructure", + "isasync": false, + "name": "listInfrastructure", + "params": [], + "related": "", + "response": [ { - "description": "indicates if this is current snapshot", - "name": "current", - "type": "boolean" + "description": "Number of zones", + "name": "zones", + "type": "integer" }, + {}, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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": "the project name where tag belongs to", - "name": "project", - "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" - } - ], - "type": "set" + "description": "Number of pods", + "name": "pods", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Number of routers", + "name": "routers", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", - "type": "string" + "description": "Number of systemvms", + "name": "systemvms", + "type": "integer" }, + {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "Number of storage pools", + "name": "storagepools", + "type": "integer" }, { - "description": "the name of the vm snapshot", - "name": "name", - "type": "string" + "description": "Number of management servers", + "name": "managementservers", + "type": "integer" }, { - "description": "the display name of the vm snapshot", - "name": "displayname", - "type": "string" + "description": "Number of internal LBs", + "name": "ilbvms", + "type": "integer" }, - {}, - {}, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", - "type": "string" + "description": "Number of clusters", + "name": "clusters", + "type": "integer" }, { - "description": "the parent ID of the vm snapshot", - "name": "parent", - "type": "string" + "description": "Number of cpu sockets", + "name": "cpusockets", + "type": "integer" }, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "string" + "description": "Number of images stores", + "name": "imagestores", + "type": "integer" }, { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" + "description": "Number of Alerts", + "name": "alerts", + "type": "integer" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "Number of hypervisor hosts", + "name": "hosts", + "type": "integer" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "Number of object stores", + "name": "objectstores", + "type": "integer" } ], - "since": "4.2.0" + "since": "4.9.3" }, { - "description": "Updates a Pod.", + "description": "Lists usage records for accounts", "isasync": false, - "name": "updatePod", + "name": "listUsageRecords", "params": [ { - "description": "the name of the Pod", + "description": "List usage records for specified project", "length": 255, - "name": "name", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the starting IP address for the Pod", + "description": "List usage records for the specified account", "length": 255, - "name": "startip", + "name": "accountid", + "related": "enableAccount,listAccounts", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the Pod", + "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", "length": 255, - "name": "id", - "related": "updatePod,createManagementNetworkIpRange", + "name": "oldformat", + "required": false, + "type": "boolean" + }, + { + "description": "Start date range for usage record query. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", + "length": 255, + "name": "startdate", "required": true, - "type": "uuid" + "type": "date" }, { - "description": "the gateway for the Pod", + "description": "Flag to enable display of Tags for a resource", "length": 255, - "name": "gateway", + "name": "includetags", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ending IP address for the Pod", + "description": "List by keyword", "length": 255, - "name": "endip", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "End date range for usage record query. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "allocationstate", + "name": "enddate", + "required": true, + "type": "date" + }, + { + "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", + "length": 255, + "name": "usageid", "required": false, "type": "string" }, { - "description": "the netmask of the Pod", + "description": "List usage records for the specified usage type", "length": 255, - "name": "netmask", + "name": "type", "required": false, - "type": "string" - } - ], - "related": "createManagementNetworkIpRange", - "response": [ + "type": "long" + }, { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" + "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", + "length": 255, + "name": "isrecursive", + "required": false, + "since": "4.15", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "List usage records for the specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "List usage records for the specified user.", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the Pod", - "name": "name", + "description": "the project name of the resource", + "name": "project", "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 gateway of the Pod", - "name": "gateway", + "description": "offering ID", + "name": "offeringid", "type": "string" }, { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - } - ], - "type": "list" + "description": "path of the domain to which the usage reocrd belongs", + "name": "domainpath", + "type": "string" }, + {}, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" + "description": "end date of the usage record", + "name": "enddate", + "type": "date" }, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": "virtual machine os display name", + "name": "osdisplayname", "type": "string" }, { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - } - ], - "type": "list" - }, - {}, - { - "description": "the ID of the Pod", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" + "description": "virtual machine os category name", + "name": "oscategoryname", + "type": "string" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "the domain the resource is associated with", + "name": "domain", "type": "string" }, - {} - ] - }, - { - "description": "Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list", - "isasync": true, - "name": "moveNetworkAclItem", - "params": [ { - "description": "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).", - "length": 255, - "name": "aclconsistencyhash", - "required": false, + "description": "id of the vpc", + "name": "vpcid", "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": "virtual size of resource", + "name": "virtualsize", + "type": "long" }, { - "description": "The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list.", - "length": 255, - "name": "previousaclruleid", - "required": false, + "description": "virtual machine os type ID", + "name": "ostypeid", "type": "string" }, { - "description": "The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list.", - "length": 255, - "name": "nextaclruleid", - "required": false, + "description": "resource or virtual machine name", + "name": "name", "type": "string" }, { - "description": "The ID of the network ACL rule that is being moved to a new position.", - "length": 255, - "name": "id", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ + "description": "number of cpu of resource", + "name": "cpunumber", + "type": "long" + }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the user account Id", + "name": "accountid", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "id of the resource", + "name": "usageid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the user account name", + "name": "account", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID", + "name": "domainid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "usage type ID", + "name": "usagetype", + "type": "integer" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "usage in hours", + "name": "usage", "type": "string" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" + "description": "speed of each cpu of resource", + "name": "cpuspeed", + "type": "long" }, { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" + "description": "virtual machine ID", + "name": "virtualmachineid", + "type": "string" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "id of the network", + "name": "networkid", "type": "string" }, { - "description": "the list of resource tags associated with the network ACLs", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -122290,18 +153225,18 @@ var preCache = `{ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -122310,13 +153245,13 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -122325,1029 +153260,858 @@ var preCache = `{ "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "start date of the usage record", + "name": "startdate", + "type": "date" + }, + { + "description": "resource type", + "name": "type", "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the zone ID", + "name": "zoneid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "description": "raw usage in hours", + "name": "rawusage", + "type": "string" + }, + { + "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", + "name": "issystem", "type": "boolean" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "template ID", + "name": "templateid", "type": "string" }, - {}, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "virtual machine guest os category ID", + "name": "oscategoryid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "resource size", + "name": "size", + "type": "long" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "True if the resource is default", + "name": "isdefault", + "type": "boolean" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the project id of the resource", + "name": "projectid", + "type": "string" + }, + { + "description": "description of the usage record", + "name": "description", "type": "string" + }, + { + "description": "memory allocated for the resource", + "name": "memory", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "True if the IPAddress is source NAT", + "name": "issourcenat", + "type": "boolean" } ] }, { - "description": "Attaches an ISO to a virtual machine.", - "isasync": true, - "name": "attachIso", + "description": "Recovers a Destroy volume.", + "isasync": false, + "name": "recoverVolume", "params": [ { - "description": "If true, ejects existing ISO before attaching on VMware. Default: false", - "length": 255, - "name": "forced", - "required": false, - "since": "4.15.1", - "type": "boolean" - }, - { - "description": "the ID of the ISO file", + "description": "The ID of the volume", "length": 255, "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": true, "type": "uuid" } ], - "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - } - ], - "type": "set" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the chain info of the volume", + "name": "chaininfo", "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 date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the domain associated with the disk volume", + "name": "domain", "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 ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, - {}, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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 ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "ID of the availability zone", "name": "zoneid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "remove Tungsten-Fabric network gateway from logical router", + "isasync": true, + "name": "removeTungstenFabricNetworkGatewayFromLogicalRouter", + "params": [ + { + "description": "Tungsten-Fabric logical router uuid", + "length": 255, + "name": "logicalrouteruuid", + "required": true, "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the project id of the group", - "name": "projectid", - "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 account associated with the tag", - "name": "account", - "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": "the project name where tag belongs to", - "name": "project", - "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 list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "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": "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": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "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 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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "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 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 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 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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Tungsten-Fabric network uuid", + "length": 255, + "name": "networkuuid", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Tungsten-Fabric logical router name", + "name": "name", + "type": "string" + }, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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 ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + } + ] + }, + { + "description": "Lists unmanaged volumes on a storage pool", + "isasync": false, + "name": "listVolumesForImport", + "params": [ + { + "description": "the ID of the storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", + "required": true, + "type": "uuid" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the path of the volume on the storage pool", + "length": 255, + "name": "path", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "name of the primary storage hosting the volume", + "name": "storage", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "the size of the volume", + "name": "size", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the encrypt format of the volume", + "name": "encryptformat", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "id of the primary storage hosting the volume", + "name": "storageid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the volume", + "name": "name", + "type": "string" + }, + { + "description": "type of the primary storage hosting the volume", + "name": "storagetype", "type": "string" }, + { + "description": "volume details in key/value pairs.", + "name": "details", + "type": "map" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the full path of the volume", + "name": "fullpath", + "type": "string" + }, + { + "description": "the format of the volume", + "name": "format", + "type": "string" + }, + { + "description": "the virtual size of the volume", + "name": "virtualsize", + "type": "long" + } + ], + "since": "4.19.1" + }, + { + "description": "Lists zone metrics", + "isasync": false, + "name": "listZonesMetrics", + "params": [ + { + "description": "the name of the zone", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the IDs of the zones, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "listZones", + "required": false, + "since": "4.19.0", + "type": "list" + }, + { + "description": "flag to display the resource image for the zones", + "length": 255, + "name": "showicon", + "required": false, "type": "boolean" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", + "length": 255, + "name": "available", + "required": false, + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the storage access group", + "length": 255, + "name": "storageaccessgroup", + "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "List zones by resource tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "since": "4.3", + "type": "map" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the network type of the zone that the virtual machine belongs to", + "length": 255, + "name": "networktype", + "required": false, "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the ID of the zone", + "length": 255, + "name": "id", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "flag to display the capacity of the zones", + "length": 255, + "name": "showcapacities", + "required": false, + "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the domain associated with the zone", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total cpu used in Ghz", + "name": "cpuused", + "type": "string" + }, + { + "description": "the display text of the zone", + "name": "displaytext", + "type": "string" + }, + { + "description": "the total cpu used in GiB", + "name": "memoryused", + "type": "string" + }, + { + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, { - "description": "the list of resource tags associated", + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" + }, + { + "description": "the list of resource tags associated with zone.", "name": "tags", "response": [ { @@ -123356,8 +154120,8 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -123366,13 +154130,13 @@ var preCache = `{ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -123381,8 +154145,8 @@ var preCache = `{ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -123391,8 +154155,13 @@ var preCache = `{ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -123404,441 +154173,890 @@ var preCache = `{ "type": "set" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "Used GPUs in the Zone", + "name": "gpuused", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the capacity of the Zone", + "name": "capacity", + "response": [ + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "healthy / total clusters in the zone", + "name": "clusters", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - } - ] - }, - { - "description": "Disassociates an IP address from the account.", - "isasync": true, - "name": "disassociateIpAddress", - "params": [ + "description": "the first DNS for the Zone", + "name": "dns1", + "type": "string" + }, { - "description": "IP Address to be disassociated. Mutually exclusive with the id parameter", - "length": 255, - "name": "ipaddress", - "required": false, - "since": "4.19.0", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter", - "length": 255, - "name": "id", - "related": "associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" - } - ], - "response": [ + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", + "type": "string" + }, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + { + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" + }, + { + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" + }, + { + "description": "true, if routed network/vpc is enabled", + "name": "routedmodeenabled", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Zone description", + "name": "description", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, + { + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" + }, + { + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" + }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the type of the zone - core or edge", + "name": "type", + "type": "string" + }, + { + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", + "type": "string" + }, + { + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" + }, + { + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", "type": "boolean" }, + { + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", + "type": "string" + }, + { + "description": "the total cpu capacity in Ghz", + "name": "cputotal", + "type": "string" + }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Zone name", + "name": "name", + "type": "string" + }, + { + "description": "the total cpu capacity in GiB", + "name": "memorytotal", + "type": "string" + }, + { + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "External network provider if any", + "name": "provider", + "type": "string" + }, + { + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" + }, + { + "description": "state of the cluster", + "name": "state", + "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "AS Number Range", + "name": "asnrange", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "Zone id", + "name": "id", + "type": "string" + }, + { + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" + }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" + }, + { + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" + }, + { + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" + }, + { + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" + }, + { + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", "type": "integer" + }, + { + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" } - ] + ], + "since": "4.9.3" }, { - "description": "list baremetal dhcp servers", - "isasync": false, - "name": "listBaremetalDhcp", + "description": "Extracts a template", + "isasync": true, + "name": "extractTemplate", "params": [ { - "description": "Type of DHCP device", + "description": "the ID of the zone where the ISO is originally located", "length": 255, - "name": "dhcpservertype", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "mode", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "DHCP server device ID", + "description": "the ID of the template", "length": 255, "name": "id", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + }, + { + "description": "the url to which the ISO would be extracted", + "length": 2048, + "name": "url", "required": false, - "type": "long" + "type": "string" + } + ], + "related": "extractSnapshot", + "response": [ + { + "description": "the status of the extraction", + "name": "status", + "type": "string" }, { "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "resultstring", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ + "description": "the name of the extracted object", + "name": "name", + "type": "string" + }, { - "description": "device id of ", + "description": "the account id to which the extracted object belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the id of extracted object", "name": "id", "type": "string" }, - {}, { - "description": "name of the provider", - "name": "dhcpservertype", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" + }, + { + "description": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the time and date the object was created", + "name": "created", + "type": "date" + }, + { + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", + "type": "string" + }, + { + "description": "type of the storage", + "name": "storagetype", "type": "string" }, {}, + { + "description": "zone name the object was extracted from", + "name": "zonename", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "url", - "name": "url", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, + {} + ] + }, + { + "description": "Expunge a virtual machine. Once expunged, it cannot be recoverd.", + "isasync": true, + "name": "expungeVirtualMachine", + "params": [ + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "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": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "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": "Puts storage pool into maintenance state", + "description": "Updates an IP address", "isasync": true, - "name": "enableStorageMaintenance", + "name": "updateIpAddress", "params": [ { - "description": "Primary storage ID", + "description": "the ID of the public IP address to update", "length": 255, "name": "id", - "related": "cancelStorageMaintenance,enableStorageMaintenance", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "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 IP to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], - "related": "cancelStorageMaintenance", + "related": "associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the name of the storage pool", - "name": "name", + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" + }, + { + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 name of the cluster for the storage pool", - "name": "clustername", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, + {}, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "public IP address id", + "name": "id", + "type": "string" + }, + { + "description": "true if range is dedicated for external network providers", + "name": "forprovider", "type": "boolean" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the name of the Network where ip belongs to", + "name": "networkname", + "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "is public ip for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "is public IP portable across the zones", + "name": "isportable", "type": "boolean" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the list of resource tags associated with ip address", + "name": "tags", + "response": [ + { + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "type": "string" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, + { + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "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 the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" + } + ] + }, + { + "description": "moves a network to another physical network", + "isasync": true, + "name": "migrateNetwork", + "params": [ + { + "description": "true if previous network migration cmd failed", + "length": 255, + "name": "resume", + "required": false, + "type": "boolean" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the ID of the network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": true, + "type": "uuid" }, - {} - ] - }, - { - "description": "Removes an existing secondary storage selector.", - "isasync": false, - "name": "removeSecondaryStorageSelector", - "params": [ { - "description": "The unique identifier of the secondary storage selector to be removed.", + "description": "network offering ID", "length": 255, - "name": "id", - "related": "removeSecondaryStorageSelector", + "name": "networkofferingid", + "related": "", "required": true, "type": "uuid" } ], - "related": "", + "related": "createNetwork,updateNetwork,listNetworks", "response": [ { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "Description of the heuristic.", - "name": "description", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "ID of the heuristic.", - "name": "id", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "Name of the heuristic.", - "name": "name", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, - {} - ], - "since": "4.19.0" - }, - { - "description": "(Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site.", - "isasync": false, - "name": "ldapRemove", - "params": [], - "related": "", - "response": [ { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", - "name": "searchbase", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "DN password", - "name": "bindpass", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "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": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { @@ -123847,201 +155065,255 @@ var preCache = `{ "type": "integer" }, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, - {}, { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "3.0.1" - }, - { - "description": "Creates a user for an account that already exists", - "isasync": false, - "name": "createUser", - "params": [ + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, { - "description": "lastname", - "length": 255, - "name": "lastname", - "required": true, + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", - "length": 255, - "name": "password", - "required": true, + "description": "the type of the network", + "name": "type", "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": true, - "type": "string" + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "email", - "length": 255, - "name": "email", - "required": true, - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "Unique username.", - "length": 255, - "name": "username", - "required": true, + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "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, + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "firstname", - "length": 255, - "name": "firstname", - "required": true, + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", - "length": 255, - "name": "userid", - "required": false, + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" - } - ], - "related": "getUser", - "response": [ + }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the type of the role", - "name": "roletype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the user firstname", - "name": "firstname", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "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" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" }, - {}, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, {}, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the owner of the network", + "name": "account", "type": "string" }, { @@ -124050,335 +155322,233 @@ var preCache = `{ "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "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": "lists all available apis on the server, provided by the Api Discovery plugin", - "isasync": false, - "name": "listApis", - "params": [ + }, + {}, { - "description": "API name", - "length": 255, - "name": "name", - "required": false, + "description": "the network's netmask", + "name": "netmask", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "api response fields", - "name": "response", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", "response": [ { - "description": "api response fields", - "name": "response", - "type": "set" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "description of the api response field", - "name": "description", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "response field type", - "name": "type", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the name of the api response field", - "name": "name", + "description": "tag key name", + "name": "key", "type": "string" - } - ], - "type": "set" - }, - { - "description": "comma separated related apis", - "name": "related", - "type": "string" - }, - { - "description": "the list params the api accepts", - "name": "params", - "response": [ + }, { - "description": "parameter type", - "name": "type", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "description of the api parameter", - "name": "description", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "version of CloudStack the api was introduced in", - "name": "since", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "comma separated related apis to get the parameter", - "name": "related", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "length of the parameter", - "name": "length", - "type": "int" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the name of the api parameter", - "name": "name", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "true if this parameter is required for the api request", - "name": "required", - "type": "boolean" + "description": "tag value", + "name": "value", + "type": "string" } ], - "type": "set" - }, - { - "description": "response field type", - "name": "type", - "type": "string" - }, - {}, - {}, - { - "description": "description of the api", - "name": "description", - "type": "string" + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "version of CloudStack the api was introduced in", - "name": "since", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if api is asynchronous", - "name": "isasync", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the api command", - "name": "name", - "type": "string" - } - ], - "since": "4.1.0" - }, - { - "description": "deletes baremetal rack configuration text", - "isasync": true, - "name": "deleteBaremetalRct", - "params": [ - { - "description": "RCT id", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "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": "Creates site to site vpn local gateway", - "isasync": true, - "name": "createVpnGateway", - "params": [ { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "public ip address id of the vpn gateway", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" - }, - {}, - {}, - { - "description": "the public IP address", - "name": "publicip", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the project id", - "name": "projectid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "the owner", - "name": "account", - "type": "string" - }, - { - "description": "the project name", - "name": "project", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" } - ] + ], + "since": "4.11.0" }, { - "description": "Creates snapshot for a vm.", - "isasync": true, - "name": "createVMSnapshot", + "description": "Lists unmanaged virtual machines for a given cluster.", + "isasync": false, + "name": "listUnmanagedInstances", "params": [ { - "description": "The description of the snapshot", + "description": "", "length": 255, - "name": "description", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "quiesce vm if true", + "description": "List by keyword", "length": 255, - "name": "quiescevm", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "The display name of the snapshot", + "description": "the cluster ID", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" }, { - "description": "snapshot memory if true", + "description": "", "length": 255, - "name": "snapshotmemory", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "The ID of the vm", + "description": "the hypervisor name of the instance", "length": 255, - "name": "virtualmachineid", - "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the description of the vm snapshot", - "name": "description", + "description": "the operating system ID of the virtual machine", + "name": "osid", + "type": "string" + }, + { + "description": "indicates the boot type", + "name": "boottype", "type": "string" }, { @@ -124387,460 +155557,481 @@ var preCache = `{ "type": "integer" }, { - "description": "the name of the vm snapshot", + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" + }, + {}, + { + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the name of the virtual machine", "name": "name", "type": "string" }, - {}, { - "description": "indicates if this is current snapshot", - "name": "current", - "type": "boolean" + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", + "type": "string" }, { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" + }, + {}, + { + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with the virtual machine", + "name": "nic", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" } ], "type": "set" }, { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", - "type": "string" - }, - { - "description": "VM Snapshot type", - "name": "type", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the ID of the vm snapshot", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the display name of the vm snapshot", - "name": "displayname", - "type": "string" - }, - { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "indicates the boot mode", + "name": "bootmode", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", "type": "string" }, { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ + { + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorehost", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", + "type": "string" + }, + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the file path of the disk image", + "name": "imagepath", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" + } + ], + "type": "set" }, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", - "type": "string" + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" } ], - "since": "4.2.0" + "since": "4.14.0" }, { - "description": "Adds detail for the Resource.", - "isasync": true, - "name": "addResourceDetail", + "description": "Registers an existing template into the CloudStack cloud.", + "isasync": false, + "name": "registerTemplate", "params": [ { - "description": "pass false if you want this detail to be disabled for the regular user. True by default", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "fordisplay", + "name": "sshkeyenabled", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "Map of (key/value pairs)", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "details", - "required": true, - "type": "map" + "name": "passwordenabled", + "required": false, + "type": "boolean" }, { - "description": "type of the resource", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "resource id to create the details for", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "resourceid", - "required": true, + "name": "arch", + "required": false, + "since": "4.20", "type": "string" - } - ], - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "length": 255, + "name": "templatetype", + "required": false, + "since": "4.19.0", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Lists vpn users", - "isasync": false, - "name": "listVpnUsers", - "params": [ { - "description": "", + "description": "true if this template requires HVM", "length": 255, - "name": "page", + "name": "requireshvm", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "The uuid of the Vpn user", + "description": "the tag for this template.", "length": 255, - "name": "id", - "related": "addVpnUser,listVpnUsers", + "name": "templatetag", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the username of the vpn user.", - "length": 255, - "name": "username", + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", "length": 255, - "name": "account", + "name": "ostypeid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "keyword", + "name": "isfeatured", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "pagesize", + "name": "isdynamicallyscalable", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "isrecursive", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "Register template for the project", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "listall", + "name": "bits", "required": false, - "type": "boolean" - } - ], - "related": "addVpnUser", - "response": [ - { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" - }, - { - "description": "the username of the vpn user", - "name": "username", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", "type": "integer" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", - "name": "state", - "type": "string" + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "length": 255, + "name": "directdownload", + "required": false, + "type": "boolean" }, { - "description": "the vpn userID", - "name": "id", - "type": "string" + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "length": 255, + "name": "format", + "required": true, "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "type": "string" + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "length": 255, + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" }, - {} - ] - }, - { - "description": "Deletes an internal load balancer", - "isasync": true, - "name": "deleteLoadBalancer", - "params": [ { - "description": "the ID of the Load Balancer", + "description": "the target hypervisor for the template", "length": 255, - "name": "id", - "related": "", + "name": "hypervisor", "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", + "description": "if true, the templates would be available for deploying CKS clusters", + "length": 255, + "name": "forcks", + "required": false, + "since": "4.21.0", "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" - }, - {} - ], - "since": "4.2.0" - }, - { - "description": "Deletes an IP forwarding rule", - "isasync": true, - "name": "deleteIpForwardingRule", - "params": [ - { - "description": "the ID of the forwarding rule", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "id", - "related": "", - "required": true, - "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": "true if operation is executed successfully", - "name": "success", + "name": "isextractable", + "required": false, "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "Register a new userdata.", - "isasync": false, - "name": "registerUserData", - "params": [ - { - "description": "Userdata content", - "length": 1048576, - "name": "userdata", - "required": true, + "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", + "required": false, "type": "string" }, { - "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, "name": "domainid", "related": "listDomains", @@ -124848,512 +156039,438 @@ var preCache = `{ "type": "uuid" }, { - "description": "Name of the userdata", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "isrouting", + "required": false, + "type": "boolean" }, { - "description": "an optional project for the userdata", + "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "zoneids", + "related": "listZones", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "comma separated list of variables declared in userdata content", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "params", + "name": "deployasis", "required": false, + "since": "4.15.1", + "type": "boolean" + }, + { + "description": "the name of the template", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "an optional account for the userdata. Must be used with domainId.", + "description": "ID of the extension", "length": 255, - "name": "account", + "name": "extensionid", + "related": "listExtensions", "required": false, - "type": "string" + "since": "4.21.0", + "type": "uuid" } ], + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.18" - }, - { - "description": "Adds a Region", - "isasync": false, - "name": "addRegion", - "params": [ + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { - "description": "Region service endpoint", - "length": 255, - "name": "endpoint", - "required": true, + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "Id of the Region", - "length": 255, - "name": "id", - "required": true, - "type": "integer" + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, { - "description": "Name of the region", - "length": 255, + "description": "the template name", "name": "name", - "required": true, "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "the ID of the region", - "name": "id", - "type": "integer" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "the end point of the region", - "name": "endpoint", + "description": "the status of the template", + "name": "status", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the name of the region", - "name": "name", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" - } - ] - }, - { - "description": "Lists Tungsten-Fabric tags", - "isasync": false, - "name": "listTungstenFabricTagType", - "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the uuid of Tungsten-Fabric tag type", - "length": 255, - "name": "tagtypeuuid", - "required": false, - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, - {}, { - "description": "Tungsten-Fabric tag type name", - "name": "name", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Generates usage records. This will generate records only if there any records to be generated, i.e if the scheduled usage job was not run or failed", - "isasync": false, - "name": "generateUsageRecords", - "params": [ - { - "description": "Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.", - "length": 255, - "name": "startdate", - "required": true, - "type": "date" - }, - { - "description": "List events for the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" }, { - "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", - "length": 255, - "name": "enddate", - "required": true, - "type": "date" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, - {} - ] - }, - { - "description": "Updates a role permission order", - "isasync": false, - "name": "updateRolePermission", - "params": [ - { - "description": "ID of the role", - "length": 255, - "name": "roleid", - "related": "", - "required": true, - "type": "uuid" - }, { - "description": "Rule permission, can be: allow or deny", - "length": 255, - "name": "permission", - "required": false, - "since": "4.11", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", - "length": 255, - "name": "ruleorder", - "related": "", - "required": false, - "type": "list" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "Role permission rule id", - "length": 255, - "name": "ruleid", - "related": "", - "required": false, - "since": "4.11", - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the zone for this template", + "name": "zonename", "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "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" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" - } - ], - "since": "4.9.0" - }, - { - "description": "List registered keypairs", - "isasync": false, - "name": "listSSHKeyPairs", - "params": [ + }, { - "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, + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, + {}, { - "description": "the ID of the ssh keypair", - "length": 255, - "name": "id", - "related": "listSSHKeyPairs", - "required": false, - "type": "uuid" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "A public key fingerprint to look for", - "length": 255, - "name": "fingerprint", - "required": false, + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "A key pair name to look for", - "length": 255, - "name": "name", - "required": false, + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "Name of the keypair", - "name": "name", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the owner of the keypair", + "description": "the account name to which the template belongs", "name": "account", "type": "string" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", - "type": "string" - }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain id of the keypair owner", - "name": "domainid", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the domain name of the keypair owner", - "name": "domain", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the project name of the keypair owner", - "name": "project", - "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 accounts and provides detailed account information for listed accounts", + "description": "List VNF appliance owned by the account.", "isasync": false, - "name": "listAccounts", + "name": "listVnfAppliances", "params": [ { - "description": "list account by account ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "enableAccount,listAccounts,listAccounts", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "flag to display the resource icon for accounts", + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", "length": 255, - "name": "showicon", + "name": "userdata", "required": false, + "since": "4.18.0.0", "type": "boolean" }, { - "description": "list accounts by cleanuprequired attribute (values are true or false)", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "iscleanuprequired", + "name": "haenable", "required": false, + "since": "4.15", "type": "boolean" }, { - "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", - "length": 255, - "name": "details", - "required": false, - "type": "list" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", @@ -125363,25 +156480,28 @@ var preCache = `{ "type": "integer" }, { - "description": "list account by account name", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "name", + "name": "ids", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "required": false, - "type": "string" + "since": "4.4", + "type": "list" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "listall", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "list vms by iso", "length": 255, - "name": "pagesize", + "name": "isoid", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -125391,540 +156511,637 @@ var preCache = `{ "type": "string" }, { - "description": "list accounts by state. Valid states are enabled, disabled, and locked.", + "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": "state", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", + "description": "Whether to return only leased instances", "length": 255, - "name": "accounttype", + "name": "leased", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the instances by userdata", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "userdataid", + "related": "", "required": false, + "since": "4.20.1", "type": "uuid" - } - ], - "related": "enableAccount,listAccounts", - "response": [ - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the total number of 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 total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "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": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.", + "length": 255, + "name": "gpuenabled", + "required": false, + "since": "4.21.0", + "type": "boolean" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "list vms by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the availability zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "the ID of the virtual machine", + "length": 255, + "name": "id", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "uuid" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "list by the service offering", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.4", + "type": "uuid" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "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": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the security group ID", + "length": 255, + "name": "securitygroupid", + "related": "", + "required": false, + "since": "4.15", + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of AutoScaling VM Group", + "length": 255, + "name": "autoscalevmgroupid", + "related": "", + "required": false, + "since": "4.18.0", + "type": "uuid" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", + "description": "flag to display the resource icon for VMs", + "length": 255, + "name": "showicon", + "required": false, + "since": "4.16.0.0", "type": "boolean" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": false, + "type": "uuid" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "CPU arch of the VM", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20.1", + "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "list vms by ssh keypair name", + "length": 255, + "name": "keypair", + "required": false, "type": "string" }, - {}, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "list by the backup offering", + "length": 255, + "name": "backupofferingid", + "related": "", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "list vms by template", + "length": 255, + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "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": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", + "length": 255, + "name": "details", + "required": false, + "type": "list" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "The ID of the Orchestrator extension for the VM", + "length": 255, + "name": "extensionid", + "related": "listExtensions", + "required": false, + "since": "4.21.0", + "type": "uuid" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the user ID that created the VM and is under the account that owns the VM", + "length": 255, + "name": "userid", + "related": "getUser", + "required": false, + "type": "uuid" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the group ID", + "length": 255, + "name": "groupid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "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 ID of the role", - "name": "roleid", - "type": "string" + "description": "list vms by vpc", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" + "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": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "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" + } + ], + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", + "response": [ + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the user lastname", - "name": "lastname", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the domain name of the user", + "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "id of the resource", + "name": "resourceid", + "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" - } - ] - }, - { - "description": "Cancels maintenance for primary storage", - "isasync": true, - "name": "cancelStorageMaintenance", - "params": [ - { - "description": "the primary storage ID", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "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 scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "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 storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { @@ -125933,457 +157150,765 @@ var preCache = `{ "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, + {}, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, - {}, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, - {} - ] - }, - { - "description": "Destroys a router.", - "isasync": true, - "name": "destroyRouter", - "params": [ { - "description": "the ID of the router", - "length": 255, - "name": "id", - "related": "destroyRouter", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, + {}, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - } - ], + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", "type": "list" }, + {}, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the project name of the address", - "name": "project", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "type": "list" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the project name of the affinity group", + "name": "project", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the affinity group", + "name": "id", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the account owning the affinity group", + "name": "account", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "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": "set" + } + ], + "type": "set" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "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 domain associated with the tag", + "name": "domain", + "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the id of the router", - "name": "id", - "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 version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the version of template", - "name": "version", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { @@ -126392,716 +157917,711 @@ var preCache = `{ "type": "boolean" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.19.1" + }, + { + "description": "Adds stratosphere ssp server", + "isasync": false, + "name": "addStratosphereSsp", + "params": [ { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "stratosphere ssp api name", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "stratosphere ssp tenant uuid", + "length": 255, + "name": "tenantuuid", + "required": false, "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "stratosphere ssp api password", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "stratosphere ssp api username", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "stratosphere ssp server url", + "length": 255, + "name": "url", + "required": true, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the host ID for the router", + "description": "server id of the stratosphere ssp server", "name": "hostid", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "url of ssp endpoint", + "name": "url", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone which this ssp controls", + "name": "zoneid", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "name", + "name": "name", "type": "string" }, + {} + ] + }, + { + "description": "Creates a storage pool.", + "isasync": false, + "name": "createStoragePool", + "params": [ { - "description": "the Pod ID for the router", + "description": "the Pod ID for the storage pool", + "length": 255, "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "comma separated list of storage access groups for connecting to hosts having those specific groups", + "length": 255, + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "IOPS CloudStack can provision from this storage pool", + "length": 255, + "name": "capacityiops", + "required": false, + "type": "long" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "length": 255, + "name": "istagarule", + "required": false, + "type": "boolean" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "bytes CloudStack can provision from this storage pool", + "length": 255, + "name": "capacitybytes", + "required": false, + "type": "long" + }, + { + "description": "the storage provider name", + "length": 255, + "name": "provider", + "required": false, "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "whether the storage should be managed by CloudStack", + "length": 255, + "name": "managed", + "required": false, + "type": "boolean" + }, + { + "description": "the Zone ID for the storage pool", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the URL of the storage pool", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the tags for the storage pool", + "length": 255, + "name": "tags", + "required": false, "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the name for the storage pool", + "length": 255, + "name": "name", + "required": true, "type": "string" - } - ] - }, - { - "description": "Updates the snapshot policy.", - "isasync": true, - "name": "updateSnapshotPolicy", - "params": [ + }, { - "description": "the ID of the snapshot policy", + "description": "the details for the storage pool", "length": 255, - "name": "id", - "related": "updateSnapshotPolicy", + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "the cluster ID for the storage pool", + "length": 255, + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.", "length": 255, - "name": "customid", + "name": "hypervisor", "required": false, - "since": "4.4", "type": "string" }, { - "description": "an optional field, whether to the display the snapshot policy to the end user or not.", + "description": "the scope of the storage: cluster or zone", "length": 255, - "name": "fordisplay", + "name": "scope", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" } ], - "related": "", + "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" - }, - {}, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the ID of the snapshot policy", + "description": "the ID of the storage pool", "name": "id", "type": "string" }, { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" - } - ] - }, - { - "description": "Retrieves the current status of asynchronous job.", - "isasync": false, - "name": "queryAsyncJobResult", - "params": [ + }, { - "description": "the ID of the asynchronous job", - "length": 255, - "name": "jobid", - "related": "queryAsyncJobResult", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the async command executed", - "name": "cmd", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, + {}, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the domain that executed the async command", - "name": "domainpath", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the result code for the job", - "name": "jobresultcode", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the result type", - "name": "jobresulttype", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the account id that executed the async command", - "name": "accountid", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the domain id that executed the async command", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, - {}, { - "description": "the account that executed the async command", - "name": "account", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, + {}, { - "description": " the created date of the job", + "description": "the date and time the storage pool was created", "name": "created", "type": "date" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, - {}, { - "description": "the user that executed the async command", - "name": "userid", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", - "type": "long" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { - "description": " the completed date of the job", - "name": "completed", - "type": "date" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" } ] }, { - "description": "Adds a netscaler control center device", - "isasync": true, - "name": "registerNetscalerControlCenter", + "description": "Lists storage pools available for migration of a volume.", + "isasync": false, + "name": "findStoragePoolsForMigration", "params": [ { - "description": "Credentials to reach netscaler controlcenter device", + "description": "List by keyword", "length": 255, - "name": "username", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "URL of the netscaler controlcenter appliance.", + "description": "", "length": 255, - "name": "ipaddress", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "the ID of the volume", "length": 255, - "name": "numretries", + "name": "id", + "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" } ], - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", + "related": "cancelStorageMaintenance,enableStorageMaintenance", "response": [ { - "description": "device name", - "name": "lbdevicename", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, - {}, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the storage pool type", + "name": "type", "type": "string" }, + {}, { - "description": "device state", - "name": "lbdevicestate", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" - } - ] - }, - { - "description": "Lists image stores.", - "isasync": false, - "name": "listImageStores", - "params": [ + }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "read-only status of the image store", - "length": 255, - "name": "readonly", - "related": "listImageStores", - "required": false, - "since": "4.15.0", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the image store", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the Zone ID for the image store", - "length": 255, + "description": "the Zone ID of the storage pool", "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the image store provider", - "length": 255, - "name": "provider", - "required": false, "type": "string" }, { - "description": "the image store protocol", - "length": 255, - "name": "protocol", - "required": false, + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the ID of the storage pool", - "length": 255, - "name": "id", - "related": "listImageStores", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Zone name of the image store", + "description": "the Zone name of the storage pool", "name": "zonename", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the name of the image store", - "name": "name", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} - ], - "since": "4.2.0" + } + ] }, { - "description": "Deletes a account, and all users associated with this account", + "description": "delete Tungsten-Fabric firewall rule", "isasync": true, - "name": "deleteAccount", + "name": "deleteTungstenFabricFirewallRule", "params": [ { - "description": "Account id", + "description": "the uuid of Tungsten-Fabric firewall rule", "length": 255, - "name": "id", - "related": "enableAccount,listAccounts", + "name": "firewallruleuuid", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" } ], "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": "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": "Adds metric counter for VM auto scaling", + "description": "disable a Cisco Nexus VSM device", "isasync": true, - "name": "createCounter", + "name": "disableCiscoNexusVSM", "params": [ { - "description": "Value of the counter e.g. oid in case of snmp.", + "description": "Id of the Cisco Nexus 1000v VSM device to be deleted", "length": 255, - "name": "value", + "name": "id", + "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "required": true, + "type": "uuid" + } + ], + "related": "listCiscoNexusVSMs", + "response": [ + { + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, { - "description": "Network provider of the counter.", - "length": 255, - "name": "provider", - "required": true, - "since": "4.18.0", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Source of the counter.", - "length": 255, - "name": "source", - "required": true, + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, { - "description": "Name of the counter.", - "length": 255, - "name": "name", - "required": true, + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" + }, + { + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" + }, + { + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" + }, + { + "description": "device name", + "name": "vsmdevicename", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "Provider of the counter.", - "name": "provider", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" }, { @@ -127110,161 +158630,161 @@ var preCache = `{ "type": "integer" }, { - "description": "Name of the counter.", - "name": "name", - "type": "string" - }, - { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { - "description": "the id of the Counter", - "name": "id", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "Source of the counter.", - "name": "source", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, {}, { - "description": "zone id of counter", - "name": "zoneid", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" } ] }, { - "description": "List Event Types", - "isasync": false, - "name": "listEventTypes", - "params": [], - "related": "", - "response": [ - {}, + "description": "Creates a Storage network IP range.", + "isasync": true, + "name": "createStorageNetworkIpRange", + "params": [ { - "description": "Event Type", - "name": "name", + "description": "the gateway for storage network", + "length": 255, + "name": "gateway", + "required": true, "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the netmask for storage network", + "length": 255, + "name": "netmask", + "required": true, + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "UUID of pod where the ip range belongs to", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" + }, + { + "description": "the ending IP address", + "length": 255, + "name": "endip", + "required": false, "type": "string" - } - ] - }, - { - "description": "Disables out-of-band management for a cluster", - "isasync": true, - "name": "disableOutOfBandManagementForCluster", - "params": [ + }, { - "description": "the ID of the cluster", + "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "vlan", + "required": false, + "type": "integer" + }, + { + "description": "the beginning IP address", + "length": 255, + "name": "startip", "required": true, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" }, {}, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the ID of the host", - "name": "hostid", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, + {}, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + } ], - "since": "4.9.0" + "since": "3.0.0" }, { - "description": "Prepares CloudStack for a safe manual shutdown by preventing new jobs from being accepted", - "isasync": false, - "name": "prepareForShutdown", + "description": "Configures an ovs element.", + "isasync": true, + "name": "configureOvsElement", "params": [ { - "description": "the uuid of the management server", + "description": "Enabled/Disabled the service provider", "length": 255, - "name": "managementserverid", - "related": "", + "name": "enabled", + "required": true, + "type": "boolean" + }, + { + "description": "the ID of the ovs provider", + "length": 255, + "name": "id", + "related": "configureOvsElement", "required": true, "type": "uuid" } @@ -127272,15 +158792,9 @@ var preCache = `{ "related": "", "response": [ { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" - }, - {}, - { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "the id of the ovs", + "name": "id", + "type": "string" }, {}, { @@ -127294,155 +158808,108 @@ var preCache = `{ "type": "integer" }, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" - }, - { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" - } - ], - "since": "4.19.0" - }, - { - "description": "Adds a new cluster", - "isasync": false, - "name": "addCluster", - "params": [ - { - "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", - "length": 255, - "name": "publicvswitchname", - "required": false, + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, + {}, { - "description": "the Pod ID for the host", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "type of the cluster: CloudManaged, ExternalManaged", - "length": 255, - "name": "clustertype", - "required": true, + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the username for the cluster", - "length": 255, - "name": "username", - "required": false, + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", - "length": 255, - "name": "guestvswitchtype", - "required": false, - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { - "description": "the username for the VSM associated with this cluster", - "length": 255, - "name": "vsmusername", - "required": false, + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { - "description": "the password for the host", - "length": 255, - "name": "password", - "required": false, + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, + "description": "the domain associated with the provider", + "name": "domain", "type": "string" - }, + } + ] + }, + { + "description": "Lists System VM stats", + "isasync": false, + "name": "listSystemVmsUsageHistory", + "params": [ { - "description": "Ovm3 native pooling enabled for cluster", + "description": "name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).", "length": 255, - "name": "ovm3pool", + "name": "name", "required": false, "type": "string" }, { - "description": "Ovm3 native OCFS2 clustering enabled for cluster", + "description": "the IDs of the system VMs, mutually exclusive with id.", "length": 255, - "name": "ovm3cluster", + "name": "ids", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", "required": false, - "type": "string" + "type": "list" }, { - "description": "the password for the VSM associated with this cluster", + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "vsmpassword", + "name": "enddate", "required": false, - "type": "string" + "type": "date" }, { - "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "guestvswitchname", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { - "description": "the ipaddress of the VSM associated with this cluster", + "description": "", "length": 255, - "name": "vsmipaddress", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Ovm3 vip to use for pool (and cluster)", + "description": "", "length": 255, - "name": "ovm3vip", + "name": "page", "required": false, - "type": "string" - }, - { - "description": "the Zone ID for the cluster", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the cluster name", - "length": 255, - "name": "clustername", - "required": true, - "type": "string" + "type": "integer" }, { - "description": "Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", + "description": "the ID of the system VM.", "length": 255, - "name": "publicvswitchtype", + "name": "id", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the URL", + "description": "List by keyword", "length": 255, - "name": "url", + "name": "keyword", "required": false, "type": "string" } @@ -127450,141 +158917,29 @@ var preCache = `{ "related": "", "response": [ { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" - }, - { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" - }, - { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "the capacity of the Cluster", - "name": "capacity", - "response": [ - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "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" - } - ], - "type": "list" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, - { - "description": "the cluster ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", - "type": "string" + "description": "the list of VM stats", + "name": "stats", + "type": "list" }, { - "description": "the cluster name", + "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { @@ -127592,199 +158947,169 @@ var preCache = `{ "name": "jobstatus", "type": "integer" }, - { - "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" - }, {} - ] + ], + "since": "4.18.0" }, { - "description": "Deletes an traffic monitor host.", - "isasync": false, - "name": "deleteTrafficMonitor", + "description": "Deletes a IPv6 firewall rule", + "isasync": true, + "name": "deleteIpv6FirewallRule", "params": [ { - "description": "Id of the Traffic Monitor Host.", + "description": "the ID of the IPv6 firewall rule", "length": 255, "name": "id", - "related": "reconnectHost,addBaremetalHost", + "related": "", "required": true, "type": "uuid" } ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, + {}, + { + "description": "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": "Removes VM from specified network by deleting a NIC", + "description": "Creates a firewall rule for a given IP address", "isasync": true, - "name": "removeNicFromVirtualMachine", + "name": "createFirewallRule", "params": [ { - "description": "Virtual Machine ID", + "description": "the ending port of firewall rule", "length": 255, - "name": "virtualmachineid", - "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", - "required": true, - "type": "uuid" + "name": "endport", + "required": false, + "type": "integer" }, { - "description": "NIC ID", + "description": "the IP address id of the port forwarding rule", "length": 255, - "name": "nicid", - "related": "", + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses", "required": true, "type": "uuid" - } - ], - "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", - "response": [ - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "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" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "type of firewallrule: system/user", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "error code for this icmp message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, + "description": "the starting port of firewall rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" + } + ], + "related": "updateEgressFirewallRule", + "response": [ { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -127792,1160 +159117,974 @@ var preCache = `{ "name": "account", "type": "string" }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + } + ] + }, + { + "description": "Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.", + "isasync": true, + "name": "createVolume", + "params": [ + { + "description": "the account associated with the disk volume. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "Arbitrary volume size", + "length": 255, + "name": "size", + "required": false, + "type": "long" + }, + { + "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the project associated with the volume. Mutually exclusive with account parameter", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "an optional field, whether to display the volume to the end user or not.", + "length": 255, + "name": "displayvolume", + "required": false, "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "min iops", + "length": 255, + "name": "miniops", + "required": false, "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "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, + "type": "string" + }, + { + "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", + "length": 255, + "name": "snapshotid", + "related": "listSnapshots", + "required": false, + "type": "uuid" + }, + { + "description": "max iops", + "length": 255, + "name": "maxiops", + "required": false, "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the disk volume", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "response": [ + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + {}, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "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": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the description of the affinity group", - "name": "description", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account owning the affinity group", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, - {}, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "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" - } - ], - "type": "set" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, - {}, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "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", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "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 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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "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" - }, - { - "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" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - } - ], - "type": "set" - }, - { - "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": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "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": "id of the resource", - "name": "resourceid", - "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 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": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "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 key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - } - ], - "type": "set" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" } ] }, { - "description": "Activates a project", - "isasync": true, - "name": "activateProject", + "description": "List virtual machine snapshot by conditions", + "isasync": false, + "name": "listVMSnapshot", "params": [ { - "description": "id of the project to be modified", + "description": "lists snapshot by snapshot name or display name", "length": 255, - "name": "id", - "related": "activateProject", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the id of the project", - "name": "id", + "name": "name", + "required": false, "type": "string" }, { - "description": "the name of the project", - "name": "name", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", + "length": 255, + "name": "vmsnapshotids", + "related": "listVMSnapshot,createVMSnapshot", + "required": false, + "since": "4.9", + "type": "list" + }, + { + "description": "state of the virtual machine snapshot", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "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": "the state of the project", - "name": "state", - "type": "string" + "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 total number of cpu cores the project can own", - "name": "cpulimit", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "The ID of the VM snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": false, + "type": "uuid" + } + ], + "related": "createVMSnapshot", + "response": [ + { + "description": "the ID of the vm snapshot", + "name": "id", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, - {}, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, - {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the description of the vm snapshot", + "name": "description", + "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "path of the domain to which the disk volume belongs", + "name": "domainpath", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "indicates if this is current snapshot", + "name": "current", + "type": "boolean" + }, + { + "description": "the parent displayName of the vm snapshot", + "name": "parentName", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "VM Snapshot type", + "name": "type", "type": "string" }, + {}, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the Zone name of the vm snapshot", + "name": "zonename", + "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the parent ID of the vm snapshot", + "name": "parent", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the display name of the vm snapshot", + "name": "displayname", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" + }, + { + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ], + "since": "4.2.0" + }, + { + "description": "Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list", + "isasync": true, + "name": "moveNetworkAclItem", + "params": [ { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list.", + "length": 255, + "name": "nextaclruleid", + "required": false, "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "The ID of the network ACL rule that is being moved to a new position.", + "length": 255, + "name": "id", + "required": true, "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list.", + "length": 255, + "name": "previousaclruleid", + "required": false, "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).", + "length": 255, + "name": "aclconsistencyhash", + "required": false, "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "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": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, + } + ], + "related": "", + "response": [ { - "description": "the list of resource tags associated with vm", + "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { @@ -128954,97 +160093,186 @@ var preCache = `{ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, + { + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, + { + "description": "the ID of the ACL Item", + "name": "id", + "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 ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" + }, + { + "description": "the protocol of the ACL", + "name": "protocol", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + {}, + { + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the starting port of ACL's port range", + "name": "startport", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Delete a certificate to CloudStack", - "isasync": false, - "name": "deleteSslCert", + "description": "Disassociates an IP address from the account.", + "isasync": true, + "name": "disassociateIpAddress", "params": [ { - "description": "Id of SSL certificate", + "description": "IP Address to be disassociated. Mutually exclusive with the id parameter", + "length": 255, + "name": "ipaddress", + "required": false, + "since": "4.19.0", + "type": "string" + }, + { + "description": "the ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter", "length": 255, "name": "id", - "related": "uploadSslCert", - "required": true, + "related": "associateIpAddress,listPublicIpAddresses", + "required": false, "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": "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", @@ -129054,9 +160282,9 @@ var preCache = `{ ] }, { - "description": "Lists dedicated hosts.", + "description": "list baremetal dhcp servers", "isasync": false, - "name": "listDedicatedHosts", + "name": "listBaremetalDhcp", "params": [ { "description": "List by keyword", @@ -129065,13 +160293,6 @@ var preCache = `{ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -129080,578 +160301,613 @@ var preCache = `{ "type": "integer" }, { - "description": "the name of the account associated with the host. Must be used with domainId.", + "description": "DHCP server device ID", "length": 255, - "name": "account", + "name": "id", "required": false, - "type": "string" + "type": "long" }, { - "description": "list dedicated hosts by affinity group", + "description": "the Physical Network ID", "length": 255, - "name": "affinitygroupid", + "name": "physicalnetworkid", "related": "", - "required": false, + "required": true, "type": "uuid" }, { - "description": "the ID of the host", + "description": "", "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the domain associated with the host", + "description": "Type of DHCP device", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "dhcpservertype", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ - {}, - {}, { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the domain ID of the host", - "name": "domainid", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the Account ID of the host", - "name": "accountid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "name of the provider", + "name": "dhcpservertype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "url", + "name": "url", "type": "string" - } + }, + {} ] }, { - "description": "upload an existing ISO into the CloudStack cloud.", - "isasync": false, - "name": "getUploadParamsForIso", + "description": "Puts storage pool into maintenance state", + "isasync": true, + "name": "enableStorageMaintenance", "params": [ { - "description": "true if you want this ISO to be featured", + "description": "Primary storage ID", "length": 255, - "name": "isfeatured", - "required": false, + "name": "id", + "related": "cancelStorageMaintenance,enableStorageMaintenance", + "required": true, + "type": "uuid" + } + ], + "related": "cancelStorageMaintenance", + "response": [ + { + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", - "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the name of the volume/template/iso", - "length": 255, - "name": "name", - "required": true, + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", - "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the display text of the ISO. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, + {}, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { - "description": "Upload volume/template/iso for the project", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} - ], - "since": "4.13" - }, - { - "description": "Get diagnostics and files from system VMs", - "isasync": true, - "name": "getDiagnosticsData", - "params": [ { - "description": "A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided.", - "length": 255, - "name": "files", - "required": false, - "type": "list" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { - "description": "The ID of the system VM instance to retrieve diagnostics data files from", - "length": 255, - "name": "targetid", - "related": "", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "the storage pool details", + "name": "details", + "type": "map" + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "Storage URL to download retrieve diagnostics data files", - "name": "url", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "Storage provider for this pool", + "name": "provider", "type": "string" } - ], - "since": "4.14.0.0" + ] }, { - "description": "Deletes a autoscale vm group.", - "isasync": true, - "name": "deleteAutoScaleVmGroup", + "description": "Removes an existing secondary storage selector.", + "isasync": false, + "name": "removeSecondaryStorageSelector", "params": [ { - "description": "the ID of the autoscale group", + "description": "The unique identifier of the secondary storage selector to be removed.", "length": 255, "name": "id", "related": "", "required": true, "type": "uuid" - }, - { - "description": "true if all VMs have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "since": "4.18.0", - "type": "boolean" } ], "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": "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.19.0" }, { - "description": "lists Palo Alto firewall devices in a physical network", + "description": "lists all available apis on the server, provided by the Api Discovery plugin", "isasync": false, - "name": "listPaloAltoFirewalls", + "name": "listApis", "params": [ { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "Palo Alto firewall device ID", - "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,listPaloAltoFirewalls", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "API name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" } ], - "related": "addPaloAltoFirewall", + "related": "", "response": [ { - "description": "the private interface of the external firewall", - "name": "privateinterface", - "type": "string" - }, - { - "description": "the private security zone of the external firewall", - "name": "privatezone", - "type": "string" - }, - { - "description": "the usage interface of the external firewall", - "name": "usageinterface", - "type": "string" - }, - { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "description of the api", + "name": "description", "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", - "type": "string" + "description": "api response fields", + "name": "response", + "response": [ + { + "description": "response field type", + "name": "type", + "type": "string" + }, + { + "description": "description of the api response field", + "name": "description", + "type": "string" + }, + { + "description": "the name of the api response field", + "name": "name", + "type": "string" + }, + { + "description": "api response fields", + "name": "response", + "type": "set" + } + ], + "type": "set" }, { - "description": "device state", - "name": "fwdevicestate", - "type": "string" + "description": "true if api is asynchronous", + "name": "isasync", + "type": "boolean" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "version of CloudStack the api was introduced in", + "name": "since", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "response field type", + "name": "type", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the name of the api command", + "name": "name", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "comma separated related apis", + "name": "related", "type": "string" }, {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + "description": "the list params the api accepts", + "name": "params", + "response": [ + { + "description": "the name of the api parameter", + "name": "name", + "type": "string" + }, + { + "description": "parameter type", + "name": "type", + "type": "string" + }, + { + "description": "length of the parameter", + "name": "length", + "type": "int" + }, + { + "description": "true if this parameter is required for the api request", + "name": "required", + "type": "boolean" + }, + { + "description": "comma separated related apis to get the parameter", + "name": "related", + "type": "string" + }, + { + "description": "version of CloudStack the api was introduced in", + "name": "since", + "type": "string" + }, + { + "description": "description of the api parameter", + "name": "description", + "type": "string" + }, + {} + ], + "type": "set" + } + ], + "since": "4.1.0" + }, + { + "description": "deletes baremetal rack configuration text", + "isasync": true, + "name": "deleteBaremetalRct", + "params": [ { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "RCT id", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "device name", - "name": "fwdevicename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] }, { - "description": "Updates load balancer", + "description": "Creates snapshot for a vm.", "isasync": true, - "name": "updateLoadBalancerRule", + "name": "createVMSnapshot", "params": [ { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "The ID of the vm", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "virtualmachineid", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", + "required": true, + "type": "uuid" }, { - "description": "The protocol for the LB", + "description": "The description of the snapshot", "length": 255, - "name": "protocol", + "name": "description", "required": false, "type": "string" }, { - "description": "the name of the load balancer rule", + "description": "quiesce vm if true", "length": 255, - "name": "name", + "name": "quiescevm", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "snapshot memory if true", "length": 255, - "name": "customid", + "name": "snapshotmemory", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "The display name of the snapshot", "length": 255, - "name": "algorithm", - "required": false, - "type": "string" - }, - { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "name": "name", "required": false, "type": "string" - }, - { - "description": "the ID of the load balancer rule to update", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" } ], - "related": "listLoadBalancerRules", + "related": "", "response": [ { - "description": "the public port", - "name": "publicport", + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VM Snapshot type", + "name": "type", + "type": "string" }, + {}, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the Zone name of the vm snapshot", + "name": "zonename", "type": "string" }, + {}, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the parent displayName of the vm snapshot", + "name": "parentName", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "indicates if this is current snapshot", + "name": "current", + "type": "boolean" + }, + { + "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 parent ID of the vm snapshot", + "name": "parent", "type": "string" }, - {}, { - "description": "the state of the rule", - "name": "state", + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the vm snapshot", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated with load balancer", + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -129660,142 +160916,196 @@ var preCache = `{ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the description of the load balancer", + "description": "the description of the vm snapshot", "name": "description", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "path of the domain to which the disk volume belongs", + "name": "domainpath", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the display name of the vm snapshot", + "name": "displayname", + "type": "string" + }, + { + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", "type": "string" - }, + } + ], + "since": "4.2.0" + }, + { + "description": "Deletes an internal load balancer", + "isasync": true, + "name": "deleteLoadBalancer", + "params": [ + { + "description": "the ID of the Load Balancer", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ {}, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "Delete one or more alerts.", + "description": "Lists Tungsten-Fabric tags", "isasync": false, - "name": "deleteAlerts", + "name": "listTungstenFabricTagType", "params": [ { - "description": "delete by alert type", + "description": "", "length": 255, - "name": "type", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "the IDs of the alerts", + "description": "", "length": 255, - "name": "ids", - "related": "", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" }, { - "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "the ID of zone", "length": 255, - "name": "enddate", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "start date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "the uuid of Tungsten-Fabric tag type", "length": 255, - "name": "startdate", + "name": "tagtypeuuid", "required": false, - "type": "date" + "type": "string" } ], + "related": "", "response": [ + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -129806,909 +161116,830 @@ var preCache = `{ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Tungsten-Fabric tag type name", + "name": "name", "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + {} ] }, { - "description": "Enables an account", - "isasync": false, - "name": "enableAccount", + "description": "Returns a download URL for extracting a snapshot. It must be in the Backed Up state.", + "isasync": true, + "name": "extractSnapshot", "params": [ { - "description": "Account id", + "description": "the ID of the zone where the snapshot is located", "length": 255, - "name": "id", - "related": "enableAccount,listAccounts", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, + "since": "4.20.0", "type": "uuid" }, { - "description": "Enables specified account in this domain.", + "description": "the ID of the snapshot", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, + "name": "id", + "related": "listSnapshots", + "required": true, + "since": "4.20.0", "type": "uuid" - }, - { - "description": "Enables specified account.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], - "related": "listAccounts", + "related": "", "response": [ { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, + {}, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "the id of the account", + "description": "the id of extracted object", "name": "id", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "zone name the object was extracted from", + "name": "zonename", + "type": "string" }, + {}, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "type of the storage", + "name": "storagetype", "type": "string" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "List registered keypairs", + "isasync": false, + "name": "listSSHKeyPairs", + "params": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, - {}, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "A public key fingerprint to look for", + "length": 255, + "name": "fingerprint", + "required": false, "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "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": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "A key pair name to look for", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "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 total volume available for this account", - "name": "volumeavailable", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, + "description": "the ID of the ssh keypair", + "length": 255, + "name": "id", + "related": "listSSHKeyPairs", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the owner of the keypair", + "name": "account", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "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 user name", - "name": "username", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - } - ], - "type": "list" + "description": "the project id of the keypair owner", + "name": "projectid", + "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, + {}, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "Name of the keypair", + "name": "name", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Cancels maintenance for primary storage", + "isasync": true, + "name": "cancelStorageMaintenance", + "params": [ + { + "description": "the primary storage ID", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, + {}, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the state of the account", + "description": "the state of the storage pool", "name": "state", - "type": "string" + "type": "storagepoolstatus" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, - {}, { - "description": "true if account is default, false otherwise", - "name": "isdefault", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - } - ] - }, - { - "description": "Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature.", - "isasync": true, - "name": "createAutoScaleVmProfile", - "params": [ + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, { - "description": "availability zone for the auto deployed virtual machine", - "length": 255, + "description": "the Zone ID of the storage pool", "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "account that will own the autoscale VM profile", - "length": 255, - "name": "account", - "required": false, + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + {}, + { + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the template of the auto deployed virtual machine", - "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { - "description": "an optional field, whether to the display the profile to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the ID of the Userdata", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "since": "4.18.1", - "type": "uuid" + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "length": 255, - "name": "autoscaleuserid", - "related": "getUser", - "required": false, - "type": "uuid" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "the service offering of the auto deployed virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, - "since": "4.18.0", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18.1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the storage pool details", + "name": "details", "type": "map" }, { - "description": "an optional project for the autoscale VM profile", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine.\nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", - "length": 255, - "name": "otherdeployparams", - "required": false, - "type": "map" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "domain ID of the account owning a autoscale VM profile", + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" + }, + { + "description": "the storage pool type", + "name": "type", + "type": "string" + } + ] + }, + { + "description": "Updates the snapshot policy.", + "isasync": true, + "name": "updateSnapshotPolicy", + "params": [ + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "description": "an optional field, whether to the display the snapshot policy to the end user or not.", "length": 255, - "name": "counterparam", + "name": "fordisplay", "required": false, - "type": "map" + "since": "4.4", + "type": "boolean" }, { - "description": "the time allowed for existing connections to get closed before a vm is expunged", + "description": "the ID of the snapshot policy", "length": 255, - "name": "expungevmgraceperiod", + "name": "id", + "related": "updateSnapshotPolicy", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the autoscale vm profile ID", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" }, - {}, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" }, + {}, + {}, { - "description": "the account owning the instance group", - "name": "account", + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, + { + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" + "description": "The list of pools in which snapshot backup is scheduled", + "name": "storage", + "type": "set" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "is profile for display to the regular user", + "description": "is this policy for display to the regular user", "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Base 64 encoded VM user data", - "name": "userdata", + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" + } + ] + }, + { + "description": "Retrieves the current status of asynchronous job.", + "isasync": false, + "name": "queryAsyncJobResult", + "params": [ + { + "description": "the ID of the asynchronous job", + "length": 255, + "name": "jobid", + "related": "queryAsyncJobResult", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": " the completed date of the job", + "name": "completed", + "type": "date" }, { - "description": "the domain ID of the vm profile", + "description": "the domain id that executed the async command", "name": "domainid", "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the domain that executed the async command", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the account id that executed the async command", + "name": "accountid", "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the user that executed the async command", + "name": "userid", "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the async command executed", + "name": "cmd", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, + {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", - "type": "string" - } - ] - }, - { - "description": "Register the OAuth2 provider in CloudStack", - "isasync": false, - "name": "registerOauthProvider", - "params": [ + "description": " the created date of the job", + "name": "created", + "type": "date" + }, { - "description": "Description of the OAuth Provider", - "length": 255, - "name": "description", - "required": true, - "type": "string" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, { - "description": "Client ID pre-registered in the specific OAuth provider", - "length": 255, - "name": "clientid", - "required": true, + "description": "the account that executed the async command", + "name": "account", "type": "string" }, { - "description": "Name of the provider from the list of OAuth providers supported in CloudStack", - "length": 255, - "name": "provider", - "required": true, + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, + {}, { - "description": "Redirect URI pre-registered in the specific OAuth provider", - "length": 255, - "name": "redirecturi", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" }, { - "description": "Secret Key pre-registered in the specific OAuth provider", - "length": 255, - "name": "secretkey", - "required": true, + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", "type": "string" - } - ], - "response": [ + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the result type", + "name": "jobresulttype", "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} - ], - "since": "4.19.0" + "type": "integer" + } + ] }, { - "description": "Lists load balancer stickiness policies.", - "isasync": false, - "name": "listLBStickinessPolicies", + "description": "Adds a netscaler control center device", + "isasync": true, + "name": "registerNetscalerControlCenter", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the load balancer stickiness policy", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "id", - "related": "listLBStickinessPolicies", - "required": false, - "type": "uuid" + "name": "username", + "required": true, + "type": "string" }, { - "description": "", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "pagesize", - "required": false, + "name": "numretries", + "required": true, "type": "integer" }, { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "password", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "URL of the netscaler controlcenter appliance.", "length": 255, - "name": "keyword", - "required": false, + "name": "ipaddress", + "required": true, "type": "string" } ], - "related": "", + "related": "addNetscalerLoadBalancer", "response": [ { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", - "response": [ - { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the LB Stickiness policy ID", - "name": "id", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the method name of the Stickiness policy", - "name": "methodname", - "type": "string" - }, - { - "description": "the params of the policy", - "name": "params", - "type": "map" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - } - ], + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" + }, + { + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", "type": "list" }, - {}, { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, + { + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", + "type": "string" + }, + { + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -130716,135 +161947,128 @@ var preCache = `{ "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, {}, { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the private interface of the load balancer", + "name": "privateinterface", + "type": "string" + }, + {}, + { + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" + }, + { + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" } - ], - "since": "3.0.0" + ] }, { - "description": "Adds a Ucs manager", - "isasync": false, - "name": "addUcsManager", + "description": "Adds metric counter for VM auto scaling", + "isasync": true, + "name": "createCounter", "params": [ { - "description": "the Zone id for the ucs manager", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the username of UCS", + "description": "Source of the counter.", "length": 255, - "name": "username", + "name": "source", "required": true, "type": "string" }, { - "description": "the name of UCS url", + "description": "Name of the counter.", "length": 255, - "name": "url", + "name": "name", "required": true, "type": "string" }, { - "description": "the password of UCS", + "description": "Value of the counter e.g. oid in case of snmp.", "length": 255, - "name": "password", + "name": "value", "required": true, "type": "string" }, { - "description": "the name of UCS manager", + "description": "Network provider of the counter.", "length": 255, - "name": "name", - "required": false, + "name": "provider", + "required": true, + "since": "4.18.0", "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of ucs manager", + "description": "Name of the counter.", "name": "name", "type": "string" }, + {}, { - "description": "the zone ID of ucs manager", - "name": "zoneid", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, { - "description": "the url of ucs manager", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Provider of the counter.", + "name": "provider", "type": "string" }, { - "description": "the ID of the ucs manager", + "description": "the id of the Counter", "name": "id", "type": "string" }, - {} - ] - }, - { - "description": "Deletes a network", - "isasync": true, - "name": "deleteNetwork", - "params": [ { - "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "description": "Source of the counter.", + "name": "source", + "type": "string" }, { - "description": "the ID of the network", - "length": 255, - "name": "id", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, - "type": "uuid" + "description": "zone id of counter", + "name": "zoneid", + "type": "string" } - ], + ] + }, + { + "description": "List Event Types", + "isasync": false, + "name": "listEventTypes", + "params": [], + "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Event Type", + "name": "name", "type": "string" }, {}, - { - "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", @@ -130854,422 +162078,456 @@ var preCache = `{ ] }, { - "description": "Reconnects a host.", - "isasync": true, - "name": "reconnectHost", + "description": "Prepares CloudStack for a safe manual shutdown by preventing new jobs from being accepted", + "isasync": false, + "name": "prepareForShutdown", "params": [ { - "description": "the host ID", + "description": "the id of the management server", "length": 255, - "name": "id", - "related": "reconnectHost,addBaremetalHost", + "name": "managementserverid", + "related": "", "required": true, "type": "uuid" } ], - "related": "addBaremetalHost", + "related": "", "response": [ { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the state of the management server", + "name": "state", + "type": "state" }, + {}, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", + "type": "boolean" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "The id of the management server", + "name": "managementserverid", + "type": "string" }, - {}, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "The number of jobs in progress", + "name": "pendingjobscount", "type": "long" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "Adds a new cluster", + "isasync": false, + "name": "addCluster", + "params": [ { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the password for the host", + "length": 255, + "name": "password", + "required": false, + "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the username for the cluster", + "length": 255, + "name": "username", + "required": false, + "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", + "length": 255, + "name": "publicvswitchtype", + "required": false, + "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", + "length": 255, + "name": "guestvswitchtype", + "required": false, "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "Details in key/value pairs to be added to the extension-resource mapping. Use the format externaldetails[i].=. Example: externaldetails[0].endpoint.url=https://example.com", + "length": 255, + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", "type": "string" }, { - "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": "the Pod ID for the host", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "type of the cluster: CloudManaged, ExternalManaged", + "length": 255, + "name": "clustertype", + "required": true, "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "Ovm3 native pooling enabled for cluster", + "length": 255, + "name": "ovm3pool", + "required": false, "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", + "length": 255, + "name": "guestvswitchname", + "required": false, + "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": "UUID of the extension", + "length": 255, + "name": "extensionid", + "related": "listExtensions", + "required": false, + "since": "4.21.0", + "type": "uuid" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the password for the VSM associated with this cluster", + "length": 255, + "name": "vsmpassword", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the URL", + "length": 255, + "name": "url", + "required": false, "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "Ovm3 native OCFS2 clustering enabled for cluster", + "length": 255, + "name": "ovm3cluster", + "required": false, + "type": "string" }, { - "description": "the cluster name of the host", + "description": "the cluster name", + "length": 255, "name": "clustername", + "required": true, "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "Ovm3 vip to use for pool (and cluster)", + "length": 255, + "name": "ovm3vip", + "required": false, + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", + "length": 255, + "name": "publicvswitchname", + "required": false, "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3,External", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the ipaddress of the VSM associated with this cluster", + "length": 255, + "name": "vsmipaddress", + "required": false, + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone ID for the cluster", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the username for the VSM associated with this cluster", + "length": 255, + "name": "vsmusername", + "required": false, "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "comma separated list of storage access groups for the hosts in the cluster", + "length": 255, + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", + "type": "list" + } + ], + "related": "", + "response": [ + { + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" }, { - "description": "the name of the host", + "description": "the cluster name", "name": "name", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, - {}, - { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the capacity of the Cluster", + "name": "capacity", + "response": [ + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + } + ], + "type": "list" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the host version", - "name": "version", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "the Zone name of the host", + "description": "the Zone name of the cluster", "name": "zonename", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, + {}, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "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" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" } ] }, { - "description": "Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected.", - "isasync": true, - "name": "deleteVnfTemplate", + "description": "Deletes an traffic monitor host.", + "isasync": false, + "name": "deleteTrafficMonitor", "params": [ { - "description": "the ID of zone of the template", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the template", + "description": "Id of the Traffic Monitor Host.", "length": 255, "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "reconnectHost", "required": true, "type": "uuid" - }, - { - "description": "Force delete a template.", - "length": 255, - "name": "forced", - "required": false, - "since": "4.9+", - "type": "boolean" } ], "response": [ @@ -131279,1033 +162537,1336 @@ var preCache = `{ "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" }, + { + "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" } - ], - "since": "4.19.0" + ] }, { - "description": "Starts a stopped CloudManaged Kubernetes cluster", + "description": "Removes VM from specified network by deleting a NIC", "isasync": true, - "name": "startKubernetesCluster", + "name": "removeNicFromVirtualMachine", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "Virtual Machine ID", "length": 255, - "name": "id", - "related": "startKubernetesCluster", + "name": "virtualmachineid", + "related": "createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "NIC ID", + "length": 255, + "name": "nicid", + "related": "", "required": true, "type": "uuid" } ], - "related": "", + "related": "createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", "response": [ { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, - {}, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, - {}, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "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 name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "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": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "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 domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "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": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" - }, - { - "description": "keypair details", - "name": "keypair", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "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 Kubernetes cluster was created", - "name": "created", - "type": "date" - }, - { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Deletes a project", - "isasync": true, - "name": "deleteProject", - "params": [ - { - "description": "true if all project resources have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "since": "4.16.0", - "type": "boolean" - }, - { - "description": "id of the project to be deleted", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "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": "3.0.0" - }, - { - "description": "lists netscaler load balancer devices", - "isasync": false, - "name": "listNetscalerLoadBalancers", - "params": [ - { - "description": "netscaler load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": false, - "type": "uuid" - } - ], - "related": "addNetscalerLoadBalancer", - "response": [ - { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, - {}, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, - {}, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "device name", - "name": "lbdevicename", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" - } - ] - }, - { - "description": "Creates a vm group", - "isasync": false, - "name": "createInstanceGroup", - "params": [ - { - "description": "The project of the instance group", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "the domain ID of account owning the instance group", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" }, { - "description": "the name of the instance group", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the ID of the instance group", - "name": "id", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, - {}, { - "description": "the name of the instance group", - "name": "name", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" - }, - { - "description": "the project ID of the instance group", - "name": "projectid", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the project name of the instance group", - "name": "project", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" - } - ] - }, - { - "description": "List iso visibility and all accounts that have permissions to view this iso.", - "isasync": false, - "name": "listIsoPermissions", - "params": [ - { - "description": "the template ID", - "length": 255, - "name": "id", - "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", - "required": true, - "type": "uuid" - } - ], - "related": "listTemplatePermissions,listIsoPermissions", - "response": [ + }, {}, { - "description": "the template ID", - "name": "id", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the list of accounts the template is available for", - "name": "account", - "type": "list" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + } + ], + "type": "set" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the list of projects the template is available for", - "name": "projectids", - "type": "list" - } - ] - }, - { - "description": "Adds a netscaler load balancer device", - "isasync": true, - "name": "addNetscalerLoadBalancer", - "params": [ - { - "description": "Credentials to reach netscaler load balancer device", - "length": 255, - "name": "username", - "required": true, - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "private IP of the site", - "length": 255, - "name": "gslbproviderprivateip", - "required": false, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", - "length": 255, - "name": "networkdevicetype", - "required": true, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "URL of the netscaler load balancer appliance.", - "length": 255, - "name": "url", - "required": true, - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "tag key name", + "name": "key", + "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" + } + ], + "type": "set" }, { - "description": "true if NetScaler device being added is for providing GSLB service", - "length": 255, - "name": "gslbprovider", - "required": false, - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "Credentials to reach netscaler load balancer device", - "length": 255, - "name": "password", - "required": true, + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "public IP of the site", - "length": 255, - "name": "gslbproviderpublicip", - "required": false, + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", - "length": 255, - "name": "isexclusivegslbprovider", - "required": false, + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" - } - ], - "related": "", - "response": [ + }, {}, { - "description": "device name", - "name": "lbdevicename", - "type": "string" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "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" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "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": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + } + ], + "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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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 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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + } + ], + "type": "set" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" - }, - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "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": "name of the provider", - "name": "provider", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, + {}, { - "description": "device state", - "name": "lbdevicestate", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" - }, - {} + } ] }, { - "description": "Creates an internal load balancer", - "isasync": true, - "name": "createLoadBalancer", + "description": "Lists dedicated hosts.", + "isasync": false, + "name": "listDedicatedHosts", "params": [ { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", - "required": true, - "type": "string" - }, - { - "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", - "length": 255, - "name": "instanceport", - "required": true, - "type": "integer" - }, - { - "description": "The guest network the load balancer will be created for", + "description": "list dedicated hosts by affinity group", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, + "name": "affinitygroupid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "the network id of the source ip address", + "description": "List by keyword", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the ID of the host", "length": 255, - "name": "fordisplay", + "name": "hostid", + "related": "reconnectHost", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "the load balancer scheme. Supported value in this release is Internal", + "description": "", "length": 255, - "name": "scheme", - "required": true, - "type": "string" - }, - { - "description": "the description of the load balancer", - "length": 4096, - "name": "description", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "name of the load balancer", + "description": "", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the source IP address the network traffic will be load balanced from", + "description": "the name of the account associated with the host. Must be used with domainId.", "length": 255, - "name": "sourceipaddress", + "name": "account", "required": false, "type": "string" }, { - "description": "the source port the network traffic will be load balanced from", + "description": "the ID of the domain associated with the host", "length": 255, - "name": "sourceport", - "required": true, - "type": "integer" + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the description of the Load Balancer", - "name": "description", - "type": "string" - }, - { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", "type": "string" }, { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" }, { - "description": "the Load Balancer ID", + "description": "the ID of the dedicated resource", "name": "id", "type": "string" }, - { - "description": "the name of the Load Balancer", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {}, - { - "description": "the domain ID of the Load Balancer", - "name": "domainid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "the name of the host", + "name": "hostname", "type": "string" }, + {}, { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - }, - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - }, - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", + "description": "the domain ID of the host", + "name": "domainid", "type": "string" }, - { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", - "response": [ - { - "description": "the name of the instance", - "name": "name", - "type": "string" - }, - { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the instance ID", - "name": "id", - "type": "string" - }, - { - "description": "the state of the instance", - "name": "state", - "type": "string" - } - ], - "type": "list" - } - ], - "since": "4.2.0" + {} + ] }, { - "description": "Removes network permissions.", - "isasync": false, - "name": "removeNetworkPermissions", + "description": "Get diagnostics and files from system VMs", + "isasync": true, + "name": "getDiagnosticsData", "params": [ { - "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "accounts", - "required": false, - "type": "list" - }, - { - "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "accountids", - "related": "listAccounts", - "required": false, - "type": "list" - }, - { - "description": "the network ID", + "description": "The ID of the system VM instance to retrieve diagnostics data files from", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "targetid", + "related": "", "required": true, "type": "uuid" }, { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided.", "length": 255, - "name": "projectids", - "related": "", + "name": "files", "required": false, "type": "list" } ], + "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Storage URL to download retrieve diagnostics data files", + "name": "url", "type": "string" }, { @@ -132313,241 +163874,125 @@ var preCache = `{ "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {} ], - "since": "4.17.0" + "since": "4.14.0.0" }, { - "description": "config Tungsten-Fabric service", + "description": "upload an existing ISO into the CloudStack cloud.", "isasync": false, - "name": "configTungstenFabricService", + "name": "getUploadParamsForIso", "params": [ { - "description": "the ID of zone", + "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "checksum", + "required": false, + "type": "string" }, { - "description": "the ID of physical network", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "physicalnetworkid", + "name": "projectid", "related": "", - "required": true, + "required": false, "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "list baremetal pxe server", - "isasync": false, - "name": "listBaremetalPxeServers", - "params": [ - { - "description": "the Physical Network ID", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "List by keyword", + "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", "length": 255, - "name": "keyword", + "name": "ostypeid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Pxe server device ID", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "id", - "required": false, - "type": "long" + "name": "format", + "required": true, + "type": "string" }, { - "description": "", + "description": "true if you want this ISO to be featured", "length": 255, - "name": "pagesize", + "name": "isfeatured", "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - {}, - { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - {}, - { - "description": "device id of ", - "name": "id", - "type": "string" - }, - { - "description": "url", - "name": "url", - "type": "string" + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Adds a Palo Alto firewall device", - "isasync": true, - "name": "addPaloAltoFirewall", - "params": [ - { - "description": "supports only PaloAltoFirewall", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "networkdevicetype", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "name": "isextractable", + "required": false, + "type": "boolean" }, { - "description": "Credentials to reach Palo Alto firewall device", + "description": "the name of the volume/template/iso", "length": 255, - "name": "username", + "name": "name", "required": true, "type": "string" }, { - "description": "Credentials to reach Palo Alto firewall device", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "bootable", + "required": false, + "type": "boolean" }, { - "description": "URL of the Palo Alto appliance.", - "length": 255, - "name": "url", - "required": true, + "description": "the display text of the ISO. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" } ], "related": "", "response": [ { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" - }, - { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", - "type": "string" - }, - { - "description": "the private security zone of the external firewall", - "name": "privatezone", - "type": "string" - }, - { - "description": "the usage interface of the external firewall", - "name": "usageinterface", - "type": "string" - }, - { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the timestamp after which the signature expires", + "name": "expires", "type": "string" }, {}, - { - "description": "the management IP address of the external firewall", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the username that's used to log in to the external firewall", - "name": "username", - "type": "string" - }, - { - "description": "the zone ID of the external firewall", - "name": "zoneid", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", @@ -132555,363 +164000,205 @@ var preCache = `{ "type": "integer" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "device name", - "name": "fwdevicename", - "type": "string" + "description": "the template/volume ID", + "name": "id", + "type": "uuid" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "signature to be sent in the POST request.", + "name": "signature", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "4.13" }, { - "description": "Creates a private gateway", + "description": "Deletes a autoscale vm group.", "isasync": true, - "name": "createPrivateGateway", + "name": "deleteAutoScaleVmGroup", "params": [ { - "description": "the VPC network belongs to", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of the network ACL", - "length": 255, - "name": "aclid", - "related": "createNetworkACLList", - "required": false, - "type": "uuid" - }, - { - "description": "the Physical Network ID the network belongs to", + "description": "the ID of the autoscale group", "length": 255, - "name": "physicalnetworkid", + "name": "id", "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "when true bypasses VLAN id/range overlap check during private gateway creation", - "length": 255, - "name": "bypassvlanoverlapcheck", - "required": false, - "type": "boolean" - }, - { - "description": "The isolated network this private gateway is associated to.", - "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": false, - "since": "4.17.0", - "type": "uuid" - }, - { - "description": "the network implementation uri for the private gateway", - "length": 255, - "name": "vlan", - "required": false, - "type": "string" - }, - { - "description": "the netmask of the Private gateway", - "length": 255, - "name": "netmask", "required": true, - "type": "string" - }, - { - "description": "the uuid of the network offering to use for the private gateways network connection", - "length": 255, - "name": "networkofferingid", - "related": "", - "required": false, "type": "uuid" }, { - "description": "the IP address of the Private gateaway", - "length": 255, - "name": "ipaddress", - "required": true, - "type": "string" - }, - { - "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported", + "description": "true if all VMs have to be cleaned up, false otherwise", "length": 255, - "name": "sourcenatsupported", + "name": "cleanup", "required": false, + "since": "4.18.0", "type": "boolean" - }, - { - "description": "the gateway of the Private gateway", - "length": 255, - "name": "gateway", - "required": true, - "type": "string" } ], - "related": "createPrivateGateway,listPrivateGateways", "response": [ - { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", - "type": "string" - }, - { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "Source Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", - "type": "string" - }, - { - "description": "the private gateway's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "the network implementation uri for the private gateway", - "name": "vlan", - "type": "string" - }, - { - "description": "the private gateway's ip address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the domain associated with the private gateway", - "name": "domain", - "type": "string" - }, - { - "description": "the id of the private gateway", - "name": "id", - "type": "string" - }, - { - "description": "the account associated with the private gateway", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the private gateway", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the project name of the private gateway", - "name": "project", - "type": "string" - }, - { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ] + }, + { + "description": "lists Palo Alto firewall devices in a physical network", + "isasync": false, + "name": "listPaloAltoFirewalls", + "params": [ { - "description": "the gateway", - "name": "gateway", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", - "type": "string" + "description": "Palo Alto firewall device ID", + "length": 255, + "name": "fwdeviceid", + "related": "listPaloAltoFirewalls", + "required": false, + "type": "uuid" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "ACL name set for private gateway", - "name": "aclname", - "type": "string" - } - ], - "since": "4.17.0" - }, - { - "description": "Find user account by API key", - "isasync": false, - "name": "getUser", - "params": [ - { - "description": "API key of the user", + "description": "", "length": 255, - "name": "userapikey", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ + {}, + {}, { - "description": "the user ID", - "name": "id", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the domain name of the user", - "name": "domain", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "device name", + "name": "fwdevicename", "type": "string" }, - {}, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" }, - {}, { - "description": "the account name of the user", - "name": "account", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { @@ -132920,248 +164207,134 @@ var preCache = `{ "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" } - ] - }, - { - "description": "Lists load balancer rules.", - "isasync": false, - "name": "listLoadBalancerRules", - "params": [ - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the availability zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "the name of the load balancer rule", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "the public IP address ID of the load balancer rule", - "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" - }, + ] + }, + { + "description": "Updates load balancer", + "isasync": true, + "name": "updateLoadBalancerRule", + "params": [ { - "description": "list by network ID the rule belongs to", + "description": "the name of the load balancer rule", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "algorithm", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the load balancer rule to update", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "id", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "List by keyword", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "keyword", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "the ID of the virtual machine of the load balancer rule", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "virtualmachineid", - "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "The protocol for the LB", "length": 255, - "name": "isrecursive", + "name": "protocol", "required": false, - "type": "boolean" + "type": "string" } ], - "related": "", + "related": "listLoadBalancerRules", "response": [ { - "description": "the name of the load balancer", - "name": "name", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, - {}, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the state of the rule", + "name": "state", "type": "string" }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -133170,105 +164343,147 @@ var preCache = `{ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "list" }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the id of the guest network the lb rule belongs to", "name": "networkid", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, - {}, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, + {}, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the project name of the load balancer", + "name": "project", "type": "string" } ] }, { - "description": "Deletes a firewall rule", - "isasync": true, - "name": "deleteFirewallRule", + "description": "Enables an account", + "isasync": false, + "name": "enableAccount", "params": [ { - "description": "the ID of the firewall rule", + "description": "Enables specified account in this domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Account id", "length": 255, "name": "id", - "related": "", - "required": true, + "related": "enableAccount,listAccounts", + "required": false, "type": "uuid" + }, + { + "description": "Enables specified account.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], + "related": "listAccounts", "response": [ { "description": "the current status of the latest async job acting on this object", @@ -133276,1483 +164491,1741 @@ var preCache = `{ "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" - } - ] - }, - { - "description": "Upload a certificate to CloudStack", - "isasync": false, - "name": "uploadSslCert", - "params": [ + }, { - "description": "domain ID of the account owning the SSL certificate", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + } + ], + "type": "list" }, { - "description": "Private key", - "length": 16384, - "name": "privatekey", - "required": true, + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "Certificate chain of trust", - "length": 2097152, - "name": "certchain", - "required": false, + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "SSL certificate", - "length": 16384, - "name": "certificate", - "required": true, + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, + {}, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "Name for the uploaded certificate", - "length": 255, - "name": "name", - "required": true, + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "an optional project for the SSL certificate", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", + "type": "string" }, { - "description": "Enables revocation checking for certificates", - "length": 255, - "name": "enabledrevocationcheck", - "required": false, - "since": "4.15", + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", "type": "boolean" }, { - "description": "Password for the private key", - "length": 255, - "name": "password", - "required": false, + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "account that will own the SSL certificate", - "length": 255, - "name": "account", - "required": false, + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "account for the certificate", - "name": "account", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "certificate chain", - "name": "certchain", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "SSL certificate ID", - "name": "id", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "certificate", - "name": "certificate", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "name", - "name": "name", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, - {}, { - "description": "the project name of the certificate", - "name": "project", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, - {}, { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" - } - ] - }, - { - "description": "Updates the registered OAuth provider details", - "isasync": false, - "name": "updateOauthProvider", - "params": [ + }, { - "description": "Client ID pre-registered in the specific OAuth provider", - "length": 255, - "name": "clientid", - "required": false, + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "Secret Key pre-registered in the specific OAuth provider", - "length": 255, - "name": "secretkey", - "required": false, + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "Redirect URI pre-registered in the specific OAuth provider", - "length": 255, - "name": "redirecturi", - "required": false, + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "OAuth provider will be enabled or disabled based on this value", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "id of the OAuth provider to be updated", - "length": 255, - "name": "id", - "related": "updateOauthProvider", - "required": true, - "type": "uuid" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "Description of the OAuth Provider", - "length": 255, - "name": "description", - "required": false, + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "Name of the provider", - "name": "provider", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, { - "description": "Description of the provider registered", - "name": "description", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "Name of the provider", - "name": "name", + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the state of the account", + "name": "state", "type": "string" }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, - {}, { - "description": "ID of the provider", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the id of the account", "name": "id", "type": "string" }, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", + "description": "the total number of backups available to this account", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", "type": "boolean" - } - ], - "since": "4.19.0" - }, - { - "description": "Creates site to site vpn customer gateway", - "isasync": true, - "name": "createVpnCustomerGateway", - "params": [ + }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", - "length": 255, - "name": "ikeversion", - "required": false, - "since": "4.15.1", + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "length": 255, - "name": "gateway", - "required": true, + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", "type": "string" }, { - "description": "name of this customer gateway", - "length": 255, - "name": "name", - "required": false, + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "length": 255, - "name": "ikepolicy", - "required": true, + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", - "length": 255, - "name": "ikelifetime", - "required": false, + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "ESP policy of the customer gateway", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", + "type": "string" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" + } + ] + }, + { + "description": "Changes the scope of a storage pool when the pool is in Disabled state.This feature is officially tested and supported for Hypervisors: KVM and VMware, Protocols: NFS and Ceph, and Storage Provider: DefaultPrimary. There might be extra steps involved to make this work for other hypervisors and storage options.", + "isasync": true, + "name": "changeStoragePoolScope", + "params": [ + { + "description": "the scope of the storage: cluster or zone", "length": 255, - "name": "esppolicy", + "name": "scope", "required": true, "type": "string" }, { - "description": "create site-to-site VPN customer gateway for the project", + "description": "the Id of the cluster to use if scope is being set to Cluster", "length": 255, - "name": "projectid", + "name": "clusterid", "related": "", "required": false, - "since": "4.6", "type": "uuid" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "the Id of the storage pool", "length": 255, - "name": "account", - "required": false, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", - "length": 255, - "name": "esplifetime", - "required": false, - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Force Encapsulation for NAT traversal", - "length": 255, - "name": "forceencap", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.19.1" + }, + { + "description": "Deletes a GPU card definition from the system", + "isasync": false, + "name": "deleteGpuCard", + "params": [ + { + "description": "the ID of the GPU card", "length": 255, - "name": "splitconnections", - "required": false, - "since": "4.15.1", + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "If DPD is enabled for VPN connection", - "length": 255, - "name": "dpd", - "required": false, - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", + "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.21.0" + }, + { + "description": "Deletes a network", + "isasync": true, + "name": "deleteNetwork", + "params": [ + { + "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "forced", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "the ID of the network", "length": 255, - "name": "cidrlist", + "name": "id", + "related": "createNetwork,updateNetwork,listNetworks", "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "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": "Reconnects a host.", + "isasync": true, + "name": "reconnectHost", + "params": [ + { + "description": "the host ID", "length": 255, - "name": "ipsecpsk", + "name": "id", + "related": "reconnectHost", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + {}, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the vpn gateway ID", + "description": "the ID of the host", "name": "id", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, - {}, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, - {}, { - "description": "the project name", - "name": "project", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the owner", - "name": "account", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" - } - ] - }, - { - "description": "Creates a Management network IP range.", - "isasync": true, - "name": "createManagementNetworkIpRange", - "params": [ + }, { - "description": "The starting IP address.", - "length": 255, - "name": "startip", - "required": true, + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "UUID of POD, where the IP range belongs to.", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "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 ending IP address.", - "length": 255, - "name": "endip", - "required": false, + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan", - "length": 255, - "name": "vlan", - "required": false, + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "Specify if range is dedicated for CPVM and SSVM.", - "length": 255, - "name": "forsystemvms", - "required": false, + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "type": "boolean" }, { - "description": "The gateway for the management network.", - "length": 255, - "name": "gateway", - "required": true, + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "The netmask for the management network.", - "length": 255, - "name": "netmask", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, { - "description": "the name of the Pod", - "name": "name", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the capacity of the Pod", - "name": "capacity", + "description": "GPU cards present in the host", + "name": "gpugroup", "response": [ { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", + "description": "GPU cards present in the host", + "name": "gpugroupname", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "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" + } + ], + "type": "list" } ], "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 virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "capabilities of the host", + "name": "capabilities", "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 cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, - {}, { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - } - ], - "type": "list" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the Pod", - "name": "id", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, - {}, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "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 host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" - } - ], - "since": "4.11.0.0" - }, - { - "description": "Retrieves a Cisco Nexus 1000v Virtual Switch Manager device associated with a Cluster", - "isasync": false, - "name": "listCiscoNexusVSMs", - "params": [ + }, { - "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", - "length": 255, - "name": "clusterid", - "related": "", - "required": false, - "type": "uuid" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, + {}, { - "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "device name", - "name": "vsmdevicename", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "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 memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "device state", - "name": "vsmdevicestate", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, - {}, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, - {}, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host version", + "name": "version", + "type": "string" + }, + {}, + { + "description": "events available for the host", + "name": "events", "type": "string" } ] }, { - "description": "Adds vpn users", + "description": "Starts a stopped CloudManaged Kubernetes cluster", "isasync": true, - "name": "addVpnUser", + "name": "startKubernetesCluster", "params": [ { - "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, + "name": "id", + "related": "startKubernetesCluster", + "required": true, "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { - "description": "password for the username", - "length": 255, - "name": "password", - "required": true, + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "username for the vpn user", - "length": 255, - "name": "username", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an optional account for the vpn user. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" + }, + { + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "add vpn user to the specific project", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the vpn userID", - "name": "id", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, + {}, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "the username of the vpn user", - "name": "username", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", - "name": "state", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" - } - ] - }, - { - "description": "remove an annotation.", - "isasync": false, - "name": "removeAnnotation", - "params": [ + }, { - "description": "the id of the annotation", - "length": 255, + "description": "the id of the Kubernetes cluster", "name": "id", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", - "type": "string" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" - }, - {}, - {}, - { - "description": "the removal timestamp for this annotation", - "name": "removed", + "description": "the date when this Kubernetes cluster was created", + "name": "created", "type": "date" }, { - "description": "the (uu)id of the annotation", - "name": "id", - "type": "string" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.11" - }, - { - "description": "add a baremetal host", - "isasync": false, - "name": "addBaremetalHost", - "params": [ - { - "description": "hypervisor type of the host", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the Zone ID for the host", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the cluster name for the host", - "length": 255, - "name": "clustername", - "required": false, - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", - "length": 255, - "name": "username", - "required": false, + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the host URL", - "length": 255, - "name": "url", - "required": true, + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", - "length": 255, - "name": "password", - "required": false, + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "Allocation state of this Host for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the Pod ID for the host", - "length": 255, - "name": "podid", - "related": "", - "required": true, - "type": "uuid" + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", + "type": "string" }, { - "description": "list of tags to be added to the host", - "length": 255, - "name": "hosttags", - "required": false, - "type": "list" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the cluster ID for the host", - "length": 255, - "name": "clusterid", - "related": "", - "required": false, - "type": "uuid" + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" }, { - "description": "ip address intentionally allocated to this host after provisioning", - "length": 255, + "description": "Public IP Address of the cluster", "name": "ipaddress", - "required": false, "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "Minimum size of the cluster", + "name": "minsize", "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", "type": "long" }, { - "description": "the host version", - "name": "version", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "keypair details", + "name": "keypair", + "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" - }, + } + ] + }, + { + "description": "Deletes a project", + "isasync": true, + "name": "deleteProject", + "params": [ { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "true if all project resources have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, + "since": "4.16.0", + "type": "boolean" }, { - "description": "the CPU number of the host", - "name": "cpunumber", + "description": "id of the project to be deleted", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Lists all available shared filesystem providers.", + "isasync": false, + "name": "listSharedFileSystemProviders", + "params": [ { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the name of the shared filesystem provider", + "name": "name", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ], + "since": "4.20.0" + }, + { + "description": "List iso visibility and all accounts that have permissions to view this iso.", + "isasync": false, + "name": "listIsoPermissions", + "params": [ { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the template ID", + "length": 255, + "name": "id", + "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", + "required": true, + "type": "uuid" + } + ], + "related": "listTemplatePermissions,listIsoPermissions", + "response": [ + { + "description": "the list of accounts the template is available for", + "name": "account", + "type": "list" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the list of projects the template is available for", + "name": "projectids", + "type": "list" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, {}, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "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" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ] + }, + { + "description": "Adds a netscaler load balancer device", + "isasync": true, + "name": "addNetscalerLoadBalancer", + "params": [ { - "description": "the cluster name of the host", - "name": "clustername", + "description": "Credentials to reach netscaler load balancer device", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "URL of the netscaler load balancer appliance.", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", + "length": 255, + "name": "isexclusivegslbprovider", + "required": false, + "type": "boolean" + }, + { + "description": "public IP of the site", + "length": 255, + "name": "gslbproviderpublicip", + "required": false, "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", + "length": 255, + "name": "networkdevicetype", + "required": true, + "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": "private IP of the site", + "length": 255, + "name": "gslbproviderprivateip", + "required": false, + "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "Credentials to reach netscaler load balancer device", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if NetScaler device being added is for providing GSLB service", + "length": 255, + "name": "gslbprovider", + "required": false, "type": "boolean" - }, + } + ], + "related": "", + "response": [ { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the private interface of the load balancer", + "name": "privateinterface", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", "type": "boolean" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, {}, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "device name", + "name": "lbdevicename", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" }, + {}, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "List backup schedule of a VM", + "isasync": false, + "name": "listBackupSchedule", + "params": [ + { + "description": "ID of the VM", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "quiesce the instance before checkpointing the disks for backup", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "ID of the backup schedule.", + "name": "id", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "name of the VM", + "name": "virtualmachinename", + "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "time the backup is scheduled to be taken.", + "name": "schedule", + "type": "string" }, + {}, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "ID of the VM", + "name": "virtualmachineid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -134760,50 +166233,54 @@ var preCache = `{ "type": "integer" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the time zone of the backup schedule", + "name": "timezone", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "maximum number of backups retained", + "name": "maxbackups", + "type": "integer" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - } - ] + "description": "the interval type of the backup schedule", + "name": "intervaltype", + "type": "intervaltype" + }, + {} + ], + "since": "4.14.0" }, { - "description": "Deletes a project role permission in the project", - "isasync": false, - "name": "deleteProjectRolePermission", + "description": "Restore and attach a backed up volume to VM", + "isasync": true, + "name": "restoreVolumeFromBackupAndAttachToVM", "params": [ { - "description": "ID of the project role permission to be deleted", + "description": "id of the VM where to attach the restored volume", "length": 255, - "name": "id", - "related": "", + "name": "virtualmachineid", + "related": "createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", "required": true, "type": "uuid" }, { - "description": "ID of the project where the project role permission is to be deleted", + "description": "ID of the VM backup", "length": 255, - "name": "projectid", + "name": "backupid", "related": "", "required": true, "type": "uuid" + }, + { + "description": "ID of the volume backed up", + "length": 255, + "name": "volumeid", + "required": true, + "type": "string" } ], "response": [ - { - "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", @@ -134814,744 +166291,937 @@ var preCache = `{ "name": "success", "type": "boolean" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ], - "since": "4.15.0" + "since": "4.14.0" }, { - "description": "Updates the quarantine end date for the given public IP address.", + "description": "Removes network permissions.", "isasync": false, - "name": "updateQuarantinedIp", + "name": "removeNetworkPermissions", "params": [ { - "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "ipaddress", + "name": "accountids", + "related": "listAccounts", "required": false, - "type": "string" + "type": "list" }, { - "description": "The ID of the public IP address in active quarantine.", + "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "id", - "related": "updateQuarantinedIp", + "name": "projectids", + "related": "", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "The date when the quarantine will no longer be active.", + "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "enddate", + "name": "accounts", + "required": false, + "type": "list" + }, + { + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": true, - "type": "date" + "type": "uuid" } ], - "related": "", "response": [ { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", - "type": "string" - }, - { - "description": "ID of the quarantine process.", - "name": "id", - "type": "string" - }, - { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "End date for the quarantine.", - "name": "enddate", - "type": "date" - }, - { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "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": "The public IP address in quarantine.", - "name": "ipaddress", - "type": "string" - }, - { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" - }, - {}, - { - "description": "When the quarantine was removed.", - "name": "removed", - "type": "date" - }, - {} + } ], - "since": "4.19" + "since": "4.17.0" }, { - "description": "Deletes a role permission", + "description": "config Tungsten-Fabric service", "isasync": false, - "name": "deleteRolePermission", + "name": "configTungstenFabricService", "params": [ { - "description": "ID of the role permission", + "description": "the ID of physical network", "length": 255, - "name": "id", + "name": "physicalnetworkid", "related": "", "required": true, "type": "uuid" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "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": "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.9.0" + {} + ] }, { - "description": "Update VM Schedule.", + "description": "list baremetal pxe server", "isasync": false, - "name": "updateVMSchedule", + "name": "listBaremetalPxeServers", "params": [ { - "description": "Enable VM schedule", + "description": "the Physical Network ID", "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "description": "List by keyword", "length": 255, - "name": "timezone", + "name": "keyword", "required": false, "type": "string" }, { - "description": "start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", + "description": "Pxe server device ID", "length": 255, - "name": "startdate", + "name": "id", "required": false, - "type": "date" + "type": "long" }, { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "description": "", "length": 255, - "name": "enddate", + "name": "page", "required": false, - "type": "date" + "type": "integer" }, { - "description": "ID of VM schedule", + "description": "", "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "device id of ", "name": "id", - "related": "updateVMSchedule", - "required": true, - "type": "uuid" + "type": "string" }, + {}, { - "description": "Name of the schedule", - "length": 255, - "name": "description", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "url", + "name": "url", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + } + ] + }, + { + "description": "Find user account by API key", + "isasync": false, + "name": "getUser", + "params": [ + { + "description": "API key of the user", "length": 255, - "name": "schedule", - "required": false, + "name": "userapikey", + "required": true, "type": "string" } ], "related": "", "response": [ { - "description": "Description of VM schedule", - "name": "description", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the ID of VM schedule", - "name": "id", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "Timezone of the schedule", - "name": "timezone", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "description": "the user name", + "name": "username", + "type": "string" }, { - "description": "Action", - "name": "action", - "type": "action" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "VM schedule is enabled", - "name": "enabled", + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the user state", + "name": "state", "type": "string" }, {}, - {} - ], - "since": "4.19.0" - }, - { - "description": "Updates a template to VNF template or attributes of a VNF template.", - "isasync": false, - "name": "updateVnfTemplate", - "params": [ { - "description": "the name of the image file", - "length": 255, - "name": "name", - "required": false, + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "the ID of the image file", + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + } + ] + }, + { + "description": "Lists load balancer rules.", + "isasync": false, + "name": "listLoadBalancerRules", + "params": [ + { + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "cleanupvnfdetails", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "sort key of the template, integer", + "description": "", "length": 255, - "name": "sortkey", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "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": "details", + "name": "listall", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "the name of the load balancer rule", "length": 255, - "name": "isrouting", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", + "description": "List by keyword", "length": 255, - "name": "vnfnics", + "name": "keyword", "required": false, - "type": "map" + "type": "string" }, { - "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "vnfdetails", + "name": "tags", "required": false, "type": "map" }, { - "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "cleanupvnfnics", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "the ID of the load balancer rule", "length": 255, - "name": "bootable", + "name": "id", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "the public IP address ID of the load balancer rule", "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" - }, - { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the format for the image", + "description": "the availability zone ID", "length": 255, - "name": "format", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "sshkeyenabled", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "templatetype", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "the ID of the virtual machine of the load balancer rule", "length": 255, - "name": "passwordenabled", + "name": "virtualmachineid", + "related": "createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "", "length": 255, - "name": "cleanupdetails", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "list by network ID the rule belongs to", "length": 255, - "name": "ostypeid", - "related": "", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, "type": "uuid" } ], - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", + "related": "", "response": [ { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the status of the template", - "name": "status", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, - {}, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, { - "description": "the template display text", - "name": "displaytext", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "the list of resource tags associated with load balancer", + "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "list" }, { - "description": "the template name", - "name": "name", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" }, { - "description": "the project name of the template", + "description": "the project name of the load balancer", "name": "project", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" }, + {}, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the load balancer rule ID", + "name": "id", + "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", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + } + ] + }, + { + "description": "Creates a Management network IP range.", + "isasync": true, + "name": "createManagementNetworkIpRange", + "params": [ { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "The netmask for the management network.", + "length": 255, + "name": "netmask", + "required": true, "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "The gateway for the management network.", + "length": 255, + "name": "gateway", + "required": true, "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "Specify if range is dedicated for CPVM and SSVM.", + "length": 255, + "name": "forsystemvms", + "required": false, "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan", + "length": 255, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "UUID of POD, where the IP range belongs to.", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "The ending IP address.", + "length": 255, + "name": "endip", + "required": false, "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "The starting IP address.", + "length": 255, + "name": "startip", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the template ID", - "name": "id", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - {}, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the capacity of the Pod", + "name": "capacity", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the Zone name", + "name": "zonename", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "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 ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "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 name of the zone for this template", - "name": "zonename", + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" + }, + {}, + { + "description": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the name of the Pod", + "name": "name", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "the ending IP for the range", + "name": "endip", + "type": "string" + }, + { + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + } + ], + "type": "list" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the ID of the Pod", + "name": "id", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ], - "since": "4.19.0" + "since": "4.11.0.0" }, { - "description": "Lists all configuration groups (primarily used for UI).", + "description": "Retrieves a Cisco Nexus 1000v Virtual Switch Manager device associated with a Cluster", "isasync": false, - "name": "listConfigurationGroups", + "name": "listCiscoNexusVSMs", "params": [ + { + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", + "length": 255, + "name": "clusterid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -135562,53 +167232,43 @@ var preCache = `{ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "lists configuration group by group name", + "description": "", "length": 255, - "name": "group", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device state", + "name": "vsmdevicestate", + "type": "string" }, { - "description": "the subgroups of the configuration group", - "name": "subgroup", - "response": [ - { - "description": "the precedence of the configuration subgroup", - "name": "precedence", - "type": "long" - }, - { - "description": "the name of the configuration subgroup", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, { - "description": "the precedence of the configuration group", - "name": "precedence", - "type": "long" + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -135616,51 +167276,51 @@ var preCache = `{ "type": "string" }, { - "description": "the name of the configuration group", - "name": "name", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, + {}, { - "description": "the description of the configuration group", - "name": "description", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, - {}, - {} - ], - "since": "4.18.0" - }, - { - "description": "Releases a Pod IP back to the Pod", - "isasync": false, - "name": "releasePodIpAddress", - "params": [ { - "description": "UUID of the Pod IP", - "length": 255, - "name": "id", - "required": true, - "type": "long" - } - ], - "response": [ + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", + "type": "string" + }, + { + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" + }, + { + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", + "type": "string" + }, + { + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", + "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -135669,72 +167329,54 @@ var preCache = `{ ] }, { - "description": "Updates VPC offering", + "description": "Adds vpn users", "isasync": true, - "name": "updateVPCOffering", + "name": "addVpnUser", "params": [ { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", - "required": false, - "type": "string" - }, - { - "description": "sort key of the VPC offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - }, - { - "description": "the name of the VPC offering", + "description": "add vpn user to the specific project", "length": 255, - "name": "name", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "password for the username", "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", + "name": "password", + "required": true, "type": "string" }, { - "description": "the id of the VPC offering", + "description": "username for the vpn user", "length": 255, - "name": "id", - "related": "updateVPCOffering", + "name": "username", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "state", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the display text of the VPC offering", + "description": "an optional account for the vpn user. Must be used with domainId.", "length": 255, - "name": "displaytext", + "name": "account", "required": false, "type": "string" } ], "related": "", "response": [ + {}, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the vpn userID", + "name": "id", "type": "string" }, { @@ -135742,207 +167384,130 @@ var preCache = `{ "name": "jobid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" + "description": "the username of the vpn user", + "name": "username", + "type": "string" }, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "the id of the vpc offering", - "name": "id", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the name of the vpc offering", - "name": "name", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, {}, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "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" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "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" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", + "name": "state", "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "description": "the domain name of the account of the remote access vpn", "name": "domain", "type": "string" }, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Updates remote access vpn", + "description": "Delete VM backup", "isasync": true, - "name": "updateRemoteAccessVpn", + "name": "deleteBackup", "params": [ { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "force the deletion of backup which removes the entire backup chain but keep VM in Backup Offering", "length": 255, - "name": "fordisplay", + "name": "forced", "required": false, - "since": "4.4", + "since": "4.18.0.0", "type": "boolean" }, { - "description": "id of the remote access vpn", + "description": "id of the VM backup", "length": 255, "name": "id", - "related": "updateRemoteAccessVpn", + "related": "", "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" } ], - "related": "", "response": [ { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ], + "since": "4.14.0" + }, + { + "description": "Deletes a project role permission in the project", + "isasync": false, + "name": "deleteProjectRolePermission", + "params": [ { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", - "type": "string" + "description": "ID of the project where the project role permission is to be deleted", + "length": 255, + "name": "projectid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "ID of the project role permission to be deleted", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -135951,221 +167516,434 @@ var preCache = `{ "type": "string" }, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", + "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.15.0" + }, + { + "description": "Updates the quarantine end date for the given public IP address.", + "isasync": false, + "name": "updateQuarantinedIp", + "params": [ + { + "description": "The ID of the public IP address in active quarantine.", + "length": 255, + "name": "id", + "related": "updateQuarantinedIp", + "required": false, + "type": "uuid" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "The date when the quarantine will no longer be active.", + "length": 255, + "name": "enddate", + "required": true, + "type": "date" + }, + { + "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" }, + {}, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the quarantine process.", + "name": "id", "type": "string" }, - {} - ], - "since": "4.4" - }, - { - "description": "Lists user two factor authenticator providers", - "isasync": false, - "name": "listUserTwoFactorAuthenticatorProviders", - "params": [ { - "description": "List user two factor authenticator provider by name", - "length": 255, - "name": "name", - "required": false, + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", "type": "string" - } - ], - "related": "", - "response": [ + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the description of the user two factor authenticator provider", - "name": "description", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, - {}, { - "description": "the user two factor authenticator provider name", - "name": "name", - "type": "string" + "description": "When the quarantine was created.", + "name": "created", + "type": "date" } ], - "since": "4.18.0" + "since": "4.19" }, { - "description": "Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.", - "isasync": true, - "name": "scaleVirtualMachine", + "description": "Updates a template to VNF template or attributes of a VNF template.", + "isasync": false, + "name": "updateVnfTemplate", "params": [ { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", "length": 255, - "name": "maxiops", + "name": "cleanupvnfnics", "required": false, - "since": "4.17", - "type": "long" + "type": "boolean" }, { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "description": "indicates that the template can be used for deployment of CKS clusters", "length": 255, - "name": "details", + "name": "forcks", "required": false, - "type": "map" + "since": "4.21.0", + "type": "boolean" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "cleanupvnfdetails", + "required": false, + "type": "boolean" }, { - "description": "Verify OK to Shrink", + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", "length": 255, - "name": "shrinkok", + "name": "cleanupdetails", "required": false, - "since": "4.17", "type": "boolean" }, { - "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "automigrate", + "name": "sshkeyenabled", "required": false, - "since": "4.17", "type": "boolean" }, { - "description": "The ID of the virtual machine", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "id", - "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", - "required": true, - "type": "uuid" + "name": "passwordenabled", + "required": false, + "type": "boolean" }, { - "description": "New minimum number of IOPS for the custom disk offering", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "miniops", + "name": "isrouting", "required": false, - "since": "4.17", - "type": "long" - } - ], - "response": [ - {}, + "type": "boolean" + }, { - "description": "any text associated with the success or failure", + "description": "the ID of the OS type that best represents the OS of this image.", + "length": 255, + "name": "ostypeid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the display text of the image", + "length": 4096, "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Force OS type update. Warning: Updating OS type will update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.", + "length": 255, + "name": "forceupdateostype", + "required": false, + "since": "4.21", + "type": "boolean" + }, + { + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "length": 255, + "name": "templatetype", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the image file", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, "type": "boolean" - } - ] - }, - { - "description": "Destroys a virtual machine. Once destroyed, only the administrator can recover it.", - "isasync": true, - "name": "destroyVirtualMachine", - "params": [ + }, { - "description": "If true is passed, the vm is expunged immediately. False by default.", + "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", "length": 255, - "name": "expunge", + "name": "vnfnics", + "required": false, + "type": "map" + }, + { + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" + }, + { + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "length": 255, + "name": "vnfdetails", + "required": false, + "type": "map" + }, + { + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "since": "4.20.0", + "type": "string" + }, + { + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "length": 255, + "name": "requireshvm", "required": false, - "since": "4.2.1", "type": "boolean" }, { - "description": "Comma separated list of UUIDs for volumes that will be deleted", + "description": "the format for the image", "length": 255, - "name": "volumeids", - "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "format", "required": false, - "since": "4.12.0", - "type": "list" + "type": "string" }, { - "description": "The ID of the virtual machine", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the image file", "length": 255, "name": "id", - "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" } ], - "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", "response": [ { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + {}, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { @@ -136173,28 +167951,28 @@ var preCache = `{ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -136203,980 +167981,686 @@ var preCache = `{ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the domain to which the template belongs", "name": "domain", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "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", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "the size of the template", + "name": "size", "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + } + ], + "since": "4.19.0" + }, + { + "description": "Updates VPC offering", + "isasync": true, + "name": "updateVPCOffering", + "params": [ + { + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "length": 255, + "name": "zoneid", + "required": false, + "since": "4.13", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "sort key of the VPC offering, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" }, - {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the VPC offering", + "length": 255, + "name": "name", + "required": false, "type": "string" }, - {}, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", + "required": false, + "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the id of the VPC offering", + "length": 255, + "name": "id", + "related": "updateVPCOffering", + "required": true, + "type": "uuid" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the display text of the VPC offering", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if vpc offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the name of the vpc offering", + "name": "name", + "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 date this vpc offering was created", + "name": "created", + "type": "date" }, + {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", "type": "boolean" }, + {}, { - "description": "the project name of the vm", - "name": "project", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", "type": "boolean" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of supported services", + "name": "service", "response": [ { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the provider name", + "name": "name", "type": "string" } ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" + "type": "list" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", + "description": "the capability value", "name": "value", "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": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the capability name", + "name": "name", "type": "string" } ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "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 type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", "type": "list" }, { - "description": "the name of the affinity group", + "description": "the service name", "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 account owning the affinity group", - "name": "account", - "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" } ], - "type": "set" + "type": "list" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the id of the vpc offering", + "name": "id", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", "type": "string" - }, + } + ] + }, + { + "description": "Lists extensions", + "isasync": false, + "name": "listExtensions", + "params": [ { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - {}, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Name of the extension", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "uuid of the extension", + "length": 255, + "name": "id", + "related": "listExtensions", + "required": false, + "type": "uuid" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "comma separated list of extension details requested, value can be a list of [all, resources, external, min]. When no parameters are passed, all the details are returned.", + "length": 255, + "name": "details", + "required": false, + "type": "list" + } + ], + "related": "", + "response": [ + { + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "Name of the extension", + "name": "name", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "The state of the extension", + "name": "state", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The path of the entry point fo the extension", + "name": "path", "type": "string" }, + {}, + {}, + {}, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "Description of the extension", + "name": "description", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "Type of the extension", + "name": "type", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "List of resources to which extension is registered to", + "name": "resources", + "response": [ + { + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" + }, + { + "description": "Type of the resource", + "name": "type", + "type": "string" + }, + { + "description": "the details of the resource map", + "name": "details", + "type": "map" + }, + { + "description": "ID of the resource associated with the extension", + "name": "id", + "type": "string" + }, + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "ID of the extension", + "name": "id", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, + "description": "The details of the extension", + "name": "details", + "type": "map" + } + ], + "since": "4.21.0" + }, + { + "description": "Lists user two factor authenticator providers", + "isasync": false, + "name": "listUserTwoFactorAuthenticatorProviders", + "params": [ { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "List user two factor authenticator provider by name", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ + {}, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the user two factor authenticator provider name", + "name": "name", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the description of the user two factor authenticator provider", + "name": "description", "type": "string" }, + {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.18.0" + }, + { + "description": "Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.", + "isasync": true, + "name": "scaleVirtualMachine", + "params": [ { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the ID of the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "Verify OK to Shrink", + "length": 255, + "name": "shrinkok", + "required": false, + "since": "4.17", + "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "New maximum number of IOPS for the custom disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.17", "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", + "required": true, + "type": "uuid" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - } - ], - "type": "set" + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "length": 255, + "name": "automigrate", + "required": false, + "since": "4.17", + "type": "boolean" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, + "description": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.17", + "type": "long" + } + ], + "response": [ { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] @@ -137195,32 +168679,52 @@ var preCache = `{ "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "fordisplay", + "name": "customid", "required": false, "since": "4.4", - "type": "boolean" + "type": "string" } ], "related": "", "response": [ { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "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 network id of the firewall rule", - "name": "networkid", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { @@ -137229,18 +168733,52 @@ var preCache = `{ "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" }, - {}, + { + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", + "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": "tag key name", - "name": "key", + "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" }, { @@ -137249,23 +168787,23 @@ var preCache = `{ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -137274,84 +168812,35 @@ var preCache = `{ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "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 ID of the firewall rule", - "name": "id", - "type": "string" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" - }, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" - }, - {} + } ], "since": "4.4" }, @@ -137361,26 +168850,28 @@ var preCache = `{ "name": "listOsCategories", "params": [ { - "description": "List by keyword", + "description": "List OS categories for which a VNF template is available", "length": 255, - "name": "keyword", + "name": "isvnf", "required": false, - "type": "string" + "since": "4.21.0", + "type": "boolean" }, { - "description": "list os category by name", + "description": "List OS categories types available for given CPU architecture", "length": 255, - "name": "name", + "name": "arch", "required": false, - "since": "3.0.1", + "since": "4.21.0", "type": "string" }, { - "description": "list Os category by id", + "description": "List available OS categories types for the zone", "length": 255, - "name": "id", - "related": "listOsCategories", + "name": "zoneid", + "related": "listZones", "required": false, + "since": "4.21.0", "type": "uuid" }, { @@ -137390,16 +168881,78 @@ var preCache = `{ "required": false, "type": "integer" }, + { + "description": "List OS category by name", + "length": 255, + "name": "name", + "required": false, + "since": "3.0.1", + "type": "string" + }, + { + "description": "List available OS categories by featured or not", + "length": 255, + "name": "isfeatured", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "flag to display the resource image for the OS category", + "length": 255, + "name": "showicon", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, { "description": "", "length": 255, "name": "page", "required": false, "type": "integer" + }, + { + "description": "List OS category by id", + "length": 255, + "name": "id", + "related": "listOsCategories", + "required": false, + "type": "uuid" + }, + { + "description": "List OS categories for which an ISO is available", + "length": 255, + "name": "isiso", + "required": false, + "since": "4.21.0", + "type": "boolean" } ], "related": "", "response": [ + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Whether the OS category is featured", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "Date when the OS category was created.", + "name": "created", + "type": "date" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -137407,6 +168960,11 @@ var preCache = `{ "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the ID of the OS category", "name": "id", @@ -137416,11 +168974,6 @@ var preCache = `{ "description": "the name of the OS category", "name": "name", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -137430,55 +168983,62 @@ var preCache = `{ "name": "listServiceOfferings", "params": [ { - "description": "listed offerings support root disk encryption", + "description": "Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", "length": 255, - "name": "encryptroot", + "name": "state", "required": false, - "since": "4.18", - "type": "boolean" + "since": "4.19", + "type": "string" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "id of zone disk offering is associated with", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.13", "type": "uuid" }, { - "description": "is this a system vm offering", + "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": "issystem", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "ID of the service offering", + "description": "name of the service offering", "length": 255, - "name": "id", - "related": "updateServiceOffering,listServiceOfferings", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.", + "length": 255, + "name": "virtualmachineid", + "related": "createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", "required": false, "type": "uuid" }, { - "description": "name of the service offering", + "description": "is this a system vm offering", "length": 255, - "name": "name", + "name": "issystem", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the CPU speed that listed offerings must support", + "description": "the RAM memory that listed offering must support", "length": 255, - "name": "cpuspeed", + "name": "memory", "required": false, "since": "4.15", "type": "integer" @@ -137492,11 +169052,20 @@ var preCache = `{ "type": "string" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "The ID of the vGPU profile that listed offerings must support", + "length": 255, + "name": "vgpuprofileid", + "related": "", + "required": false, + "since": "4.21.0", + "type": "uuid" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -137506,49 +169075,51 @@ var preCache = `{ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "The ID of the template that listed offerings must support", "length": 255, - "name": "account", + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", "required": false, - "type": "string" + "since": "4.20.0", + "type": "uuid" }, { - "description": "List by keyword", + "description": "listed offerings support root disk encryption", "length": 255, - "name": "keyword", + "name": "encryptroot", "required": false, - "type": "string" + "since": "4.18", + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "ID of the service offering", "length": 255, - "name": "projectid", - "related": "", + "name": "id", + "related": "updateServiceOffering,listServiceOfferings", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.", + "description": "", "length": 255, - "name": "virtualmachineid", - "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the CPU number that listed offerings must support", + "description": "Flag to indicate if the service offering supports GPU. If set to true, only service offerings that support GPU will be returned.", "length": 255, - "name": "cpunumber", + "name": "gpuenabled", "required": false, - "since": "4.15", - "type": "integer" + "since": "4.21.0", + "type": "boolean" }, { "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", @@ -137558,39 +169129,95 @@ var preCache = `{ "type": "string" }, { - "description": "the RAM memory that listed offering must support", + "description": "the CPU number that listed offerings must support", "length": 255, - "name": "memory", + "name": "cpunumber", "required": false, "since": "4.15", "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "id of zone disk offering is associated with", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": false, + "since": "4.13", "type": "uuid" + }, + { + "description": "the CPU speed that listed offerings must support", + "length": 255, + "name": "cpuspeed", + "required": false, + "since": "4.15", + "type": "integer" } ], "related": "updateServiceOffering", "response": [ { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "state of the service offering", + "name": "state", "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" + }, + { + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the date this service offering was created", + "name": "created", + "type": "date" + }, { "description": "the ha support in the service offering", "name": "offerha", @@ -137601,54 +169228,80 @@ var preCache = `{ "name": "diskIopsReadRateMaxLength", "type": "long" }, + {}, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" }, { - "description": "the storage type for this service offering", - "name": "storagetype", - "type": "string" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, + { + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", "type": "boolean" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "the name of the service offering", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", + "description": "Action to be taken once lease is over", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the host tag for the service offering", + "name": "hosttags", + "type": "string" + }, + { + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" + }, + { + "description": "Instance lease duration (in days) for service offering", + "name": "leaseduration", "type": "integer" }, { @@ -137657,44 +169310,39 @@ var preCache = `{ "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", + "description": "is this a default system vm offering", + "name": "defaultuse", "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { "description": "the max iops of the disk offering", @@ -137702,39 +169350,64 @@ var preCache = `{ "type": "long" }, { - "description": "the name of the service offering", - "name": "name", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "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", + "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", + "name": "isvolatile", + "type": "boolean" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" + }, + { + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the number of CPU", + "name": "cpunumber", "type": "integer" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, + { + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" + }, { "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "name": "provisioningtype", "type": "string" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { "description": "the id of the service offering", @@ -137742,23 +169415,28 @@ var preCache = `{ "type": "string" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" + "description": "the count of GPUs to attach ", + "name": "gpucount", + "type": "integer" }, { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "the memory in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { @@ -137767,81 +169445,60 @@ var preCache = `{ "type": "long" }, { - "description": "is this a system vm offering", - "name": "issystem", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", "type": "boolean" }, - {}, - { - "description": "the date this service offering was created", - "name": "created", - "type": "date" - }, - { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" - }, - {}, - { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" - }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, + {}, { "description": "burst io requests write rate of the disk offering", "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" - }, - { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether GPU device is used for display or not ", + "name": "gpudisplay", "type": "boolean" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "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 zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" + }, + { + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" } ] }, @@ -137851,23 +169508,38 @@ var preCache = `{ "name": "importVm", "params": [ { - "description": "path of the disk image", + "description": "the cluster ID", "length": 255, - "name": "diskpath", + "name": "clusterid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "VM nic to ip address mapping using keys nic, ip4Address", + "length": 255, + "name": "nicipaddresslist", + "required": false, + "type": "map" + }, + { + "description": "the username for the host", + "length": 255, + "name": "username", "required": false, "type": "string" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) Name of VMware cluster.", + "description": "the host name or IP address", "length": 255, - "name": "clustername", + "name": "host", "required": false, "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "the host name of the instance", "length": 255, - "name": "account", + "name": "hostname", "required": false, "type": "string" }, @@ -137879,52 +169551,100 @@ var preCache = `{ "type": "string" }, { - "description": "the username for the host", + "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", "length": 255, - "name": "username", + "name": "existingvcenterid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "the display name of the instance", + "description": "the zone ID", "length": 255, - "name": "displayname", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the password for the host", + "length": 255, + "name": "password", "required": false, "type": "string" }, { - "description": "the network ID", + "description": "(only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "convertinstancepoolid", + "related": "", "required": false, "type": "uuid" }, { - "description": "Temp Path on external host for disk image copy", + "description": "the service offering for the virtual machine", "length": 255, - "name": "temppath", + "name": "serviceofferingid", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" + }, + { + "description": "(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.", + "length": 255, + "name": "hostip", "required": false, "type": "string" }, { - "description": "the host name of the instance", + "description": "path of the disk image", "length": 255, - "name": "hostname", + "name": "diskpath", "required": false, "type": "string" }, { - "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "description": "Source location for Import", "length": 255, - "name": "migrateallowed", + "name": "importsource", + "required": true, + "type": "string" + }, + { + "description": "VM nic to network id mapping using keys nic and network", + "length": 255, + "name": "nicnetworklist", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the password for the host", + "description": "the network ID", "length": 255, - "name": "password", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "(only for importing VMs from VMware to KVM) optional - the host to import the converted instance from VMware to KVM.", + "length": 255, + "name": "importinstancehostid", + "related": "", + "required": false, + "since": "4.19.2", + "type": "uuid" + }, + { + "description": "Temp Path on external host for disk image copy", + "length": 255, + "name": "temppath", "required": false, "type": "string" }, @@ -137936,6 +169656,27 @@ var preCache = `{ "required": false, "type": "uuid" }, + { + "description": "the display name of the instance", + "length": 255, + "name": "displayname", + "required": false, + "type": "string" + }, + { + "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", + "length": 255, + "name": "datacentername", + "required": false, + "type": "string" + }, + { + "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "length": 255, + "name": "migrateallowed", + "required": false, + "type": "boolean" + }, { "description": "Shared storage pool where disk is located", "length": 255, @@ -137945,12 +169686,40 @@ var preCache = `{ "type": "uuid" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) VMware ESXi host IP/Name.", + "description": "(only for importing VMs from VMware to KVM) optional - if true, forces MS to export OVF from VMware to temporary storage, else uses KVM Host if ovftool is available, falls back to MS if not.", "length": 255, - "name": "hostip", + "name": "forcemstoimportvmfiles", + "required": false, + "type": "boolean" + }, + { + "description": "(only for importing VMs from VMware to KVM) Name of VMware cluster.", + "length": 255, + "name": "clustername", + "required": false, + "type": "string" + }, + { + "description": "(only for importing VMs from VMware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "length": 255, + "name": "vcenter", "required": false, "type": "string" }, + { + "description": "used to specify the custom parameters.", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "length": 255, + "name": "datadiskofferinglist", + "required": false, + "type": "map" + }, { "description": "Host where local disk is located", "length": 255, @@ -137960,7 +169729,23 @@ var preCache = `{ "type": "uuid" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) optional - the host to perform the virt-v2v migration from VMware to KVM.", + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "import instance for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "(only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v conversion from VMware to KVM.", "length": 255, "name": "convertinstancehostid", "related": "", @@ -137968,143 +169753,344 @@ var preCache = `{ "type": "uuid" }, { - "description": "import instance for the project", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, + { + "description": "hypervisor type of the host", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + } + ], + "related": "createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances", + "response": [ + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + {}, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the 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 maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "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 VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + {}, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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 hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) Name of VMware datacenter.", - "length": 255, - "name": "datacentername", - "required": false, - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", - "length": 255, - "name": "nicipaddresslist", - "required": false, - "type": "map" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "hypervisor type of the host", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "used to specify the custom parameters.", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", - "length": 255, - "name": "vcenter", - "required": false, + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", - "length": 255, - "name": "datadiskofferinglist", - "required": false, - "type": "map" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) UUID of a linked existing vCenter", - "length": 255, - "name": "existingvcenterid", - "related": "", - "required": false, - "type": "uuid" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the ID of the template for the virtual machine", - "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", - "required": false, - "type": "uuid" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "VM nic to network id mapping using keys nic and network", - "length": 255, - "name": "nicnetworklist", - "required": false, - "type": "map" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "", - "required": true, - "type": "uuid" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the service offering for the virtual machine", - "length": 255, + "description": "the ID of the service offering of the virtual machine", "name": "serviceofferingid", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "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": "(only for importing migrated VMs from Vmware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.", - "length": 255, - "name": "convertinstancepoolid", - "related": "", - "required": false, - "type": "uuid" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "Source location for Import", - "length": 255, - "name": "importsource", - "required": true, - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the host name or IP address", - "length": 255, - "name": "host", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ], - "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", - "response": [ - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { "description": "the memory allocated for the virtual machine", @@ -138112,77 +170098,92 @@ var preCache = `{ "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -138191,61 +170192,86 @@ var preCache = `{ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the ID of the nic", - "name": "id", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the extra dhcp options on the nic", @@ -138253,33 +170279,38 @@ var preCache = `{ "type": "list" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -138288,23 +170319,33 @@ var preCache = `{ "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -138313,158 +170354,46 @@ var preCache = `{ "type": "list" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the nic", + "name": "id", "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": "the ip address of the nic", - "name": "ipaddress", + "name": "macaddress", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" } ], "type": "set" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - {}, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - {}, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { @@ -138473,131 +170402,51 @@ var preCache = `{ "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -138605,38 +170454,43 @@ var preCache = `{ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" }, { @@ -138645,27 +170499,27 @@ var preCache = `{ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the starting IP of the security group rule", @@ -138673,21 +170527,16 @@ var preCache = `{ "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { @@ -138696,43 +170545,115 @@ var preCache = `{ "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "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" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "account owning the security group rule", + "description": "the project id the tag belongs to", + "name": "projectid", + "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 account associated with the tag", "name": "account", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { "description": "the protocol of the security group rule", @@ -138740,8 +170661,8 @@ var preCache = `{ "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -138749,6 +170670,11 @@ var preCache = `{ "name": "icmpcode", "type": "integer" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the type of the ICMP message response", "name": "icmptype", @@ -138759,23 +170685,23 @@ var preCache = `{ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -138784,145 +170710,93 @@ var preCache = `{ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "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" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the name of the security group", + "name": "name", "type": "string" } ], "type": "set" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, { "description": "the type of the affinity group", "name": "type", @@ -138935,197 +170809,121 @@ var preCache = `{ }, { "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "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 pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, - {}, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" } ], "since": "4.19.0" @@ -139136,20 +170934,20 @@ var preCache = `{ "name": "removeFromGlobalLoadBalancerRule", "params": [ { - "description": "The ID of the load balancer rule", + "description": "the list load balancer rules that will be assigned to global load balancer rule", "length": 255, - "name": "id", + "name": "loadbalancerrulelist", "related": "", "required": true, - "type": "uuid" + "type": "list" }, { - "description": "the list load balancer rules that will be assigned to global load balancer rule", + "description": "The ID of the load balancer rule", "length": 255, - "name": "loadbalancerrulelist", + "name": "id", "related": "", "required": true, - "type": "list" + "type": "uuid" } ], "response": [ @@ -139158,23 +170956,23 @@ var preCache = `{ "name": "success", "type": "boolean" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -139192,14 +170990,14 @@ var preCache = `{ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -139207,22 +171005,22 @@ var preCache = `{ "related": "", "response": [ { - "description": "the type of the affinity group", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { @@ -139231,27 +171029,34 @@ var preCache = `{ "name": "listCapacity", "params": [ { - "description": "recalculate capacities and fetch the latest", + "description": "Sort the results. Available values: Usage", "length": 255, - "name": "fetchlatest", + "name": "sortby", "required": false, "since": "3.0.0", - "type": "boolean" + "type": "string" }, { - "description": "Sort the results. Available values: Usage", + "description": "Tag for the resource type", "length": 255, - "name": "sortby", + "name": "tag", "required": false, - "since": "3.0.0", + "since": "4.20.0", "type": "string" }, { - "description": "List by keyword", + "description": "lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.", "length": 255, - "name": "keyword", + "name": "type", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { "description": "", @@ -139270,11 +171075,11 @@ var preCache = `{ "type": "uuid" }, { - "description": "lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "lists capacity by the Pod ID", @@ -139293,53 +171098,59 @@ var preCache = `{ "type": "uuid" }, { - "description": "", + "description": "recalculate capacities and fetch the latest", "length": 255, - "name": "page", + "name": "fetchlatest", "required": false, - "type": "integer" + "since": "3.0.0", + "type": "boolean" } ], "related": "", "response": [ { - "description": "the Pod name", - "name": "podname", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { @@ -139347,11 +171158,6 @@ var preCache = `{ "name": "jobstatus", "type": "integer" }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, {}, { "description": "the Zone ID", @@ -139359,1064 +171165,503 @@ var preCache = `{ "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, - {}, { "description": "the percentage of capacity currently in use", "name": "percentused", "type": "string" }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - } + {} ] }, { - "description": "Starts a virtual machine.", - "isasync": true, - "name": "startVirtualMachine", + "description": "Updates a service offering.", + "isasync": false, + "name": "updateServiceOffering", "params": [ { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "state of the service offering", "length": 255, - "name": "hostid", - "related": "", + "name": "state", "required": false, - "since": "3.0.1", - "type": "uuid" + "type": "string" }, { - "description": "The ID of the virtual machine", + "description": "the ID of the service offering to be updated", "length": 255, "name": "id", - "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", + "related": "updateServiceOffering", "required": true, "type": "uuid" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", - "length": 255, - "name": "deploymentplanner", - "required": false, - "since": "4.4", - "type": "string" - }, - { - "description": "Boot into hardware setup menu or not", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "bootintosetup", + "name": "externaldetails", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "since": "4.21.0", + "type": "map" }, { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "sort key of the service offering, integer", "length": 255, - "name": "clusterid", - "related": "", + "name": "sortkey", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process.", + "description": "Whether to cleanup VM and its associated resource upon expunge", "length": 255, - "name": "considerlasthost", + "name": "purgeresources", "required": false, - "since": "4.18.0", + "since": "4.20", "type": "boolean" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, - "name": "podid", - "related": "", + "name": "zoneid", "required": false, - "type": "uuid" - } - ], - "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", - "response": [ - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "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", + "since": "4.13", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", + "required": false, "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the service offering to be updated", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the host tag for this service offering.", + "length": 255, + "name": "hosttags", + "required": false, + "since": "4.16", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", + "length": 255, + "name": "storagetags", + "required": false, + "since": "4.16", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the display text of the service offering to be updated", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { - "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": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", "type": "boolean" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the name of the virtual machine", + "description": "the name of the service offering", "name": "name", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", + "description": "the memory in MB", "name": "memory", "type": "integer" }, { - "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": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", + "description": "the date this service offering was created", "name": "created", "type": "date" }, - {}, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "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 VM's disk read in KiB", - "name": "diskkbsread", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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 list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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": "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, - {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the count of GPUs to attach ", + "name": "gpucount", + "type": "integer" }, - {}, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "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 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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "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" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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 project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "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" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - } - ], - "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 project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" + { + "description": "the tags for the service offering", + "name": "storagetags", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" + }, + { + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "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 user's ID who deployed the virtual machine", - "name": "userid", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "Action to be taken once lease is over", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, + {}, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the id of the service offering", + "name": "id", "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 vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", "type": "integer" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" + }, + { + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "Instance lease duration (in days) for service offering", + "name": "leaseduration", "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" + }, + { + "description": "whether GPU device is used for display or not ", + "name": "gpudisplay", + "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 maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the storage type for this service offering", + "name": "storagetype", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + { + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "state of the service offering", + "name": "state", "type": "string" }, + { + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" + }, + { + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "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 description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", + "name": "isvolatile", + "type": "boolean" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "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", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" + } + ] + }, + { + "description": "Stops a virtual machine.", + "isasync": true, + "name": "stopVirtualMachine", + "params": [ + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances", + "required": true, + "type": "uuid" }, + { + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). This option is to be used if the caller knows the VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + } + ], + "related": "createVMFromBackup,scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances", + "response": [ { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -140440,168 +171685,86 @@ var preCache = `{ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - } - ] - }, - { - "description": "Updates a service offering.", - "isasync": false, - "name": "updateServiceOffering", - "params": [ - { - "description": "the ID of the service offering to be updated", - "length": 255, - "name": "id", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" - }, - { - "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", - "length": 255, - "name": "storagetags", - "required": false, - "since": "4.16", - "type": "string" - }, - { - "description": "sort key of the service offering, integer", - "length": 255, - "name": "sortkey", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", - "type": "string" - }, - { - "description": "the display text of the service offering to be updated", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the host tag for this service offering.", - "length": 255, - "name": "hosttags", - "required": false, - "since": "4.16", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", - "required": false, + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the service offering to be updated", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the name of the service offering", - "name": "name", - "type": "string" - }, - { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" - }, - { - "description": "the id of the service offering", - "name": "id", - "type": "string" - }, - { - "description": "the memory in MB", - "name": "memory", - "type": "integer" - }, - { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" - }, - {}, - { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, - {}, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" - }, - { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { @@ -140610,239 +171773,527 @@ var preCache = `{ "type": "boolean" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" - }, - { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "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": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" - }, - { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" - }, - { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", "type": "string" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the date this service offering was created", - "name": "created", - "type": "date" - }, - { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" - } - ] - }, - { - "description": "Stops a virtual machine.", - "isasync": true, - "name": "stopVirtualMachine", - "params": [ - { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). This option is to be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "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": "tag key name", + "name": "key", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "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" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "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": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "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 protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "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 type of the ICMP message response", + "name": "icmptype", + "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", - "required": true, - "type": "uuid" - } - ], - "related": "scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", - "response": [ - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "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 ID of the backup offering of the virtual machine", @@ -140850,211 +172301,196 @@ var preCache = `{ "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, { "description": "VNF details", "name": "vnfdetails", "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the project id the tag belongs to", + "description": "the project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", "type": "string" } ], "type": "set" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, + {}, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, { "description": "the date when this virtual machine was created", "name": "created", "type": "date" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "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": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, - {}, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -141063,43 +172499,33 @@ var preCache = `{ "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -141108,379 +172534,236 @@ var preCache = `{ "type": "boolean" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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 IPv6 address of network", - "name": "ip6address", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" } ], "type": "set" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "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 ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "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 description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "device type of the root volume", + "name": "rootdevicetype", "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", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, - {}, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, { "description": "ID of AutoScale VM group", "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { @@ -141489,375 +172772,23 @@ var preCache = `{ "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 amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "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": "tag value", - "name": "value", - "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": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "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 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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -141872,13 +172803,6 @@ var preCache = `{ "isasync": true, "name": "createNetworkACLList", "params": [ - { - "description": "Description of the network ACL list", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "ID of the VPC associated with this network ACL list", "length": 255, @@ -141887,13 +172811,6 @@ var preCache = `{ "required": false, "type": "uuid" }, - { - "description": "Name of the network ACL list", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "an optional field, whether to the display the list to the end user or not", "length": 255, @@ -141901,54 +172818,68 @@ var preCache = `{ "required": false, "since": "4.4", "type": "boolean" + }, + { + "description": "Description of the network ACL list", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "Name of the network ACL list", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the ID of the ACL", "name": "id", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Description of the ACL", "name": "description", "type": "string" }, + {}, + { + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", + "type": "string" + }, + {}, { "description": "is ACL for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Name of the ACL", + "name": "name", "type": "string" }, - {}, { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Name of the ACL", - "name": "name", + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", "type": "string" } ] } ], - "count": 754 -}` + "count": 880 +} diff --git a/config/cache.go b/config/cache.go index 7359427..510075a 100644 --- a/config/cache.go +++ b/config/cache.go @@ -18,6 +18,7 @@ package config import ( + _ "embed" // for embedding apis.json "encoding/json" "fmt" "io/ioutil" @@ -33,6 +34,9 @@ const ( FilePathArg = "filepath=" ) +//go:embed apis.json +var bundledAPICache []byte + // APIArg are the args passable to an API type APIArg struct { Name string @@ -89,7 +93,7 @@ func LoadCache(c *Config) interface{} { cache, err := ioutil.ReadFile(cacheFile) if err != nil { fmt.Fprintf(os.Stderr, "Loaded in-built API cache. Failed to read API cache, please run 'sync'.\n") - cache = []byte(preCache) + cache = bundledAPICache } var data map[string]interface{} _ = json.Unmarshal(cache, &data)